Skip to content

docs: meta descriptions for every page that had none - #8698

Merged
dimitrieh merged 3 commits into
mainfrom
docs/meta-descriptions
Sep 29, 2026
Merged

dimitrieh merged 3 commits into
mainfrom
docs/meta-descriptions

Conversation

@dimitrieh

@dimitrieh dimitrieh commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adds a one-sentence meta.description to every docs page that had none, and replaces two misspelled keys (descriptions:, descripition:) that nothing read. It also links the MCP server nodes at /docs/flowfuse-nodes/mcp/ instead of the old /node-red/ URL, which 301s. The descriptions start rendering on flowfuse.com once FlowFuse/website#5625 merges.

Related Issue(s)

https://flowfuse.slack.com/archives/C02TG4WH5PC/p1790618200472239

Checklist

  • I have read the contribution guidelines
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
    • Upgrade instructions
    • Configuration details
    • Concepts
  • Changes flowforge.yml?
    • Issue/PR raised on FlowFuse/helm to update ConfigMap Template
    • Issue/PR raised on FlowFuse/CloudProject to update values for Staging/Production
  • Link to Changelog Entry PR, or note why one is not needed. Not needed: docs frontmatter and links only.

Labels

  • Includes a DB migration? -> add the area:migration label

Search results and link previews showed the first paragraph, or nothing, for
these pages. Each now has a meta.description of one sentence, around 140
characters, saying what the page lets the reader do. Only frontmatter changes.

Two pages carried a misspelled key (`descriptions:` on admin/introduction,
`descripition:` on install/first-run) that nothing read; they are replaced by
the real key. persistent-context.md had no frontmatter and gains a block.
devops-pipelines, expert/chat, role-based-access-control and snapshots
reached main without a meta.description after the previous commit was
written, so it no longer covered every page. Same shape: one sentence,
around 140 characters, saying what the page lets the reader do.
Three pages linked the MCP server nodes at
https://flowfuse.com/node-red/flowfuse/mcp/, which has 301d to
/docs/flowfuse-nodes/mcp/ since the Node-RED library moved into /docs.
They now link the page directly. The URL stays absolute because the
page lives in FlowFuse/website, so a /docs/... path would fail the
repo-relative link check here.
@dimitrieh
dimitrieh merged commit 8b180cf into main Sep 29, 2026
15 checks passed
@dimitrieh
dimitrieh deleted the docs/meta-descriptions branch September 29, 2026 12:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants