From e6253a851c982fb6fefa8cf80bf72a0b5fced050 Mon Sep 17 00:00:00 2001 From: Dimitrie Hoekstra Date: Fri, 25 Sep 2026 20:45:43 +0200 Subject: [PATCH 1/3] docs: a meta description for every page that had none 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. --- docs/admin/introduction.md | 2 +- docs/admin/sso/README.md | 2 ++ docs/install/first-run.md | 2 +- docs/user/bill-of-materials.md | 2 ++ docs/user/changestack.md | 2 ++ docs/user/concepts.md | 2 ++ docs/user/custom-hostnames.md | 2 ++ docs/user/custom-npm-packages.md | 2 ++ docs/user/device-groups.md | 2 ++ docs/user/envvar.md | 2 ++ docs/user/expert/index.md | 2 ++ docs/user/expert/node-red-embedded-ai.md | 2 ++ docs/user/expert/third-party-agents.md | 2 ++ docs/user/ff-tables.md | 2 ++ docs/user/filenodes.md | 2 ++ docs/user/high-availability.md | 2 ++ docs/user/http-access-tokens.md | 2 ++ docs/user/instance-settings.md | 2 ++ docs/user/instance-states.md | 2 ++ docs/user/introduction.md | 2 ++ docs/user/logs.md | 2 ++ docs/user/mcp.md | 2 ++ docs/user/mqtt-nodes.md | 2 ++ docs/user/persistent-context.md | 5 +++++ docs/user/projectnodes.md | 2 ++ docs/user/shared-library.md | 2 ++ docs/user/static-asset-service.md | 2 ++ docs/user/team/README.md | 2 ++ docs/user/teambroker.md | 2 ++ docs/user/user-settings.md | 2 ++ 30 files changed, 61 insertions(+), 2 deletions(-) diff --git a/docs/admin/introduction.md b/docs/admin/introduction.md index 8fe18338fd..8761a676fe 100644 --- a/docs/admin/introduction.md +++ b/docs/admin/introduction.md @@ -2,7 +2,7 @@ navTitle: Administering FlowFuse navOrder: 1 meta: - descriptions: Learn how to administer FlowFuse with this comprehensive guide. Explore user management, team setup, instance and stack management, and more. + description: Reach the Admin Settings and manage registration options, users, teams, team types, instance types, stacks and templates on a FlowFuse platform. tags: - flowfuse - nodered diff --git a/docs/admin/sso/README.md b/docs/admin/sso/README.md index 9ca97308fc..99b52287d2 100644 --- a/docs/admin/sso/README.md +++ b/docs/admin/sso/README.md @@ -1,5 +1,7 @@ --- navTitle: Configuring Single Sign-On (SSO) +meta: + description: See how SAML and LDAP single sign-on work on self-hosted Enterprise FlowFuse, and how the email domain picks the provider for each user. --- # Configuring Single Sign-On diff --git a/docs/install/first-run.md b/docs/install/first-run.md index e41bf294f5..8f1e65aa63 100644 --- a/docs/install/first-run.md +++ b/docs/install/first-run.md @@ -1,7 +1,7 @@ --- navTitle: First Run Setup meta: - descripition: Get started with FlowFuse using our concise first-run setup guide, covering initial access, administrator creation, license uploading, and platform setup. + description: Complete the first-run setup after installing FlowFuse by creating the administrator account and optionally uploading an Enterprise license. tags: - setup - flowfuse diff --git a/docs/user/bill-of-materials.md b/docs/user/bill-of-materials.md index a3dffaa3af..1cad13c477 100644 --- a/docs/user/bill-of-materials.md +++ b/docs/user/bill-of-materials.md @@ -1,6 +1,8 @@ --- navTitle: Bill of Materials navOrder: 2 +meta: + description: Use the Bill of Materials in an application's Dependencies tab to view and search the dependencies and versions used by all its instances. --- # Bill of Materials diff --git a/docs/user/changestack.md b/docs/user/changestack.md index 799b7844c3..a62bb2428f 100644 --- a/docs/user/changestack.md +++ b/docs/user/changestack.md @@ -1,5 +1,7 @@ --- navTitle: Changing the Stack +meta: + description: Change the stack a Node-RED instance runs on from its Settings tab in FlowFuse, for example to upgrade to a newer Node-RED version. --- # Changing the Stack diff --git a/docs/user/concepts.md b/docs/user/concepts.md index ad45e29a3d..727ca2a867 100644 --- a/docs/user/concepts.md +++ b/docs/user/concepts.md @@ -1,6 +1,8 @@ --- navTitle: FlowFuse Concepts navOrder: 2 +meta: + description: Understand the core FlowFuse concepts, including teams, applications, hosted and remote instances, stacks, templates, snapshots and pipelines. --- # FlowFuse Concepts diff --git a/docs/user/custom-hostnames.md b/docs/user/custom-hostnames.md index e899613267..416c669b42 100644 --- a/docs/user/custom-hostnames.md +++ b/docs/user/custom-hostnames.md @@ -1,5 +1,7 @@ --- navTitle: Custom Hostnames +meta: + description: Point a custom subdomain such as dashboard.example.com at a FlowFuse instance by setting the hostname and adding a CNAME record. --- # Custom Hostnames diff --git a/docs/user/custom-npm-packages.md b/docs/user/custom-npm-packages.md index fec7a5cc64..864fe0648b 100644 --- a/docs/user/custom-npm-packages.md +++ b/docs/user/custom-npm-packages.md @@ -1,5 +1,7 @@ --- navTitle: Custom Node Packages +meta: + description: Publish private Node-RED nodes to the FlowFuse Custom Node Registry, or connect an instance to a third-party npm registry and catalogue. --- # Custom Node Packages diff --git a/docs/user/device-groups.md b/docs/user/device-groups.md index 22b5390b37..c431bd5801 100644 --- a/docs/user/device-groups.md +++ b/docs/user/device-groups.md @@ -1,5 +1,7 @@ --- navTitle: Groups +meta: + description: Create groups of remote instances in an application, manage their membership, and set group-level environment variables for pipeline deployments. --- # Groups diff --git a/docs/user/envvar.md b/docs/user/envvar.md index aa7d303b5d..c621dd0c75 100644 --- a/docs/user/envvar.md +++ b/docs/user/envvar.md @@ -1,5 +1,7 @@ --- navTitle: Environment Variables +meta: + description: Set, import and manage environment variables for a Node-RED instance in FlowFuse, and see the standard variables the platform provides. --- # Environment Variables diff --git a/docs/user/expert/index.md b/docs/user/expert/index.md index a85a04d036..c406b78bd7 100644 --- a/docs/user/expert/index.md +++ b/docs/user/expert/index.md @@ -1,5 +1,7 @@ --- navTitle: FlowFuse Expert +meta: + description: See what FlowFuse Expert does in its Chat Interface and in the Node-RED editor, how to turn AI features on or off, and how data is handled. --- # FlowFuse Expert diff --git a/docs/user/expert/node-red-embedded-ai.md b/docs/user/expert/node-red-embedded-ai.md index 1cd3a6eaa5..a0816a692f 100644 --- a/docs/user/expert/node-red-embedded-ai.md +++ b/docs/user/expert/node-red-embedded-ai.md @@ -1,5 +1,7 @@ --- navTitle: AI in Node-RED +meta: + description: Use FlowFuse Expert's AI inside the Node-RED editor for flow autocomplete, code completion, flow explanations and JSON, CSS and HTML generation. --- # AI in Node-RED diff --git a/docs/user/expert/third-party-agents.md b/docs/user/expert/third-party-agents.md index 9225d3a1cb..3ad7619705 100644 --- a/docs/user/expert/third-party-agents.md +++ b/docs/user/expert/third-party-agents.md @@ -1,5 +1,7 @@ --- navTitle: Connect Your Own Agent +meta: + description: Connect your own MCP-capable AI agent, such as Copilot, ChatGPT or Claude, to FlowFuse to manage the platform and build Node-RED flows. --- # Connect Your Own Agent diff --git a/docs/user/ff-tables.md b/docs/user/ff-tables.md index 6534877553..1b6e939222 100644 --- a/docs/user/ff-tables.md +++ b/docs/user/ff-tables.md @@ -1,5 +1,7 @@ --- navTitle: FlowFuse Tables +meta: + description: Create a FlowFuse Tables database for an Enterprise team, build tables with the wizard, and query it from Node-RED or any Postgres client. --- # FlowFuse Tables diff --git a/docs/user/filenodes.md b/docs/user/filenodes.md index e3871d7e05..be6902a17c 100644 --- a/docs/user/filenodes.md +++ b/docs/user/filenodes.md @@ -1,5 +1,7 @@ --- navTitle: FlowFuse File Nodes +meta: + description: See how Node-RED file nodes store files in FlowFuse, from the older FlowFuse File Nodes to Persistent Storage in FlowFuse 2.7.0 and later. --- # FlowFuse File Nodes diff --git a/docs/user/high-availability.md b/docs/user/high-availability.md index 7c1d05345a..76fc3f1df8 100644 --- a/docs/user/high-availability.md +++ b/docs/user/high-availability.md @@ -1,5 +1,7 @@ --- navTitle: High Availability mode +meta: + description: Run multiple copies of a Node-RED instance in High Availability mode, and build flows that handle shared state and load-balanced work. --- # High Availability mode diff --git a/docs/user/http-access-tokens.md b/docs/user/http-access-tokens.md index a6d66465f0..f824229abd 100644 --- a/docs/user/http-access-tokens.md +++ b/docs/user/http-access-tokens.md @@ -1,5 +1,7 @@ --- navTitle: HTTP Access Tokens +meta: + description: Create HTTP access tokens so other applications can reach the dashboard and HTTP endpoints of a FlowFuse instance secured with user authentication. --- # HTTP Access Tokens diff --git a/docs/user/instance-settings.md b/docs/user/instance-settings.md index 3d4e44d326..bc5ce51ba8 100644 --- a/docs/user/instance-settings.md +++ b/docs/user/instance-settings.md @@ -1,5 +1,7 @@ --- navTitle: Instance Settings +meta: + description: Change a Node-RED instance's settings in FlowFuse, covering stack, environment, High Availability, editor, security, palette and alerts. --- # Instance Settings diff --git a/docs/user/instance-states.md b/docs/user/instance-states.md index 29cd50f9a1..b211979d74 100644 --- a/docs/user/instance-states.md +++ b/docs/user/instance-states.md @@ -1,6 +1,8 @@ --- navTitle: Instance States navOrder: 10 +meta: + description: Look up the stable and transitional states a hosted or remote Node-RED instance can be in on FlowFuse, and what each state means. --- # FlowFuse Node-RED Instance States diff --git a/docs/user/introduction.md b/docs/user/introduction.md index 4129835194..19c3b9b7d0 100644 --- a/docs/user/introduction.md +++ b/docs/user/introduction.md @@ -1,6 +1,8 @@ --- navTitle: Getting Started navOrder: 1 +meta: + description: Create your first hosted and remote Node-RED instances in FlowFuse, pick a blueprint, and set up a first DevOps Pipeline. --- # Getting Started with FlowFuse diff --git a/docs/user/logs.md b/docs/user/logs.md index cb7ddb900b..4d6371c0cd 100644 --- a/docs/user/logs.md +++ b/docs/user/logs.md @@ -1,5 +1,7 @@ --- navTitle: Logging +meta: + description: Find the Node-RED logs, instance audit log and team audit log in FlowFuse, and see how AI agent and API actions are marked. --- # Logs diff --git a/docs/user/mcp.md b/docs/user/mcp.md index 7bf70f5759..c03ef2d4c1 100644 --- a/docs/user/mcp.md +++ b/docs/user/mcp.md @@ -1,5 +1,7 @@ --- navTitle: FlowFuse MCP +meta: + description: See what an AI agent can do through the FlowFuse MCP server, from platform actions to building flows, and how read-only or full access limits it. --- # FlowFuse MCP Server diff --git a/docs/user/mqtt-nodes.md b/docs/user/mqtt-nodes.md index e54c6714d7..1f1248574c 100644 --- a/docs/user/mqtt-nodes.md +++ b/docs/user/mqtt-nodes.md @@ -1,5 +1,7 @@ --- navTitle: FlowFuse MQTT Nodes +meta: + description: Use the FlowFuse MQTT In and MQTT Out nodes to publish and subscribe through the Team Broker without configuring any broker settings. --- # FlowFuse MQTT Nodes diff --git a/docs/user/persistent-context.md b/docs/user/persistent-context.md index 1662b1bea9..cdb57cbd04 100644 --- a/docs/user/persistent-context.md +++ b/docs/user/persistent-context.md @@ -1,3 +1,8 @@ +--- +meta: + description: Keep Node-RED context values across restarts and stack updates by selecting the persistent context store in nodes and in Function node code. +--- + # FlowFuse Persistent Context Some Node-RED flows require the ability to persist context values between restarts and FlowFuse stack updates. By default, context data in Node-RED is ephemeral, meaning it does not survive restarts or stack updates. With FlowFuse's paid plans, however, you can enable **persistent context storage**, ensuring that your context values persist across restarts, upgrades, and more. diff --git a/docs/user/projectnodes.md b/docs/user/projectnodes.md index 362ec93160..1747759536 100644 --- a/docs/user/projectnodes.md +++ b/docs/user/projectnodes.md @@ -1,5 +1,7 @@ --- navTitle: FlowFuse Project Nodes +meta: + description: Send messages and call flows between Node-RED instances in a team with the Project In, Out and Call nodes, and the limits for remote instances. --- # FlowFuse Project Nodes diff --git a/docs/user/shared-library.md b/docs/user/shared-library.md index c53fd4c493..69e65a73d9 100644 --- a/docs/user/shared-library.md +++ b/docs/user/shared-library.md @@ -1,5 +1,7 @@ --- navTitle: Shared Team Library +meta: + description: Share flows and functions between Node-RED instances by exporting them to, and importing them from, the FlowFuse Team Library. --- # Shared Team Library diff --git a/docs/user/static-asset-service.md b/docs/user/static-asset-service.md index 9d003b529f..46682f6be9 100644 --- a/docs/user/static-asset-service.md +++ b/docs/user/static-asset-service.md @@ -1,6 +1,8 @@ --- navTitle: Static asset service navOrder: 1 +meta: + description: Upload and manage files and folders on a hosted Node-RED instance with the Static Asset Service, and serve folders publicly on a static path. --- # Static asset service diff --git a/docs/user/team/README.md b/docs/user/team/README.md index e65631224d..c93c8b72e2 100644 --- a/docs/user/team/README.md +++ b/docs/user/team/README.md @@ -1,5 +1,7 @@ --- navTitle: Teams +meta: + description: Create a FlowFuse team, invite members with an initial role, and remove members who should no longer have access to the team's data. --- # Teams diff --git a/docs/user/teambroker.md b/docs/user/teambroker.md index 6dc1f8b055..2e30c0cb98 100644 --- a/docs/user/teambroker.md +++ b/docs/user/teambroker.md @@ -1,5 +1,7 @@ --- navTitle: Team Broker +meta: + description: Create Team Broker clients and connect MQTT clients or Node-RED to the FlowFuse broker, with the hostname, ports and client ID rules. --- # Getting Started with Team Broker diff --git a/docs/user/user-settings.md b/docs/user/user-settings.md index f65347bd3c..62a9c118bc 100644 --- a/docs/user/user-settings.md +++ b/docs/user/user-settings.md @@ -1,5 +1,7 @@ --- navTitle: User Settings +meta: + description: Change your FlowFuse username, email, theme and password, set up two-factor authentication, and create scoped personal access tokens. --- # User Settings From ea7bb94080f3023fc85758a3465c58fa57ee48c9 Mon Sep 17 00:00:00 2001 From: Dimitrie Hoekstra Date: Tue, 29 Sep 2026 14:02:10 +0200 Subject: [PATCH 2/3] docs: descriptions for the four pages added since 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. --- docs/user/devops-pipelines.md | 2 ++ docs/user/expert/chat.md | 2 ++ docs/user/role-based-access-control.md | 2 ++ docs/user/snapshots.md | 2 ++ 4 files changed, 8 insertions(+) diff --git a/docs/user/devops-pipelines.md b/docs/user/devops-pipelines.md index 072603508f..c309d47507 100644 --- a/docs/user/devops-pipelines.md +++ b/docs/user/devops-pipelines.md @@ -1,5 +1,7 @@ --- navTitle: DevOps Pipelines +meta: + description: Set up a DevOps pipeline to move flows and configuration from a development instance to production, and protect instances from direct edits. --- # DevOps Pipelines diff --git a/docs/user/expert/chat.md b/docs/user/expert/chat.md index ed50b87bbc..24ca4b0362 100644 --- a/docs/user/expert/chat.md +++ b/docs/user/expert/chat.md @@ -1,5 +1,7 @@ --- navTitle: Chat Interface +meta: + description: Use the FlowFuse Expert chat in Support mode to build and debug flows on your canvas, or in Insights mode to query live operational data. --- # Chat Interface diff --git a/docs/user/role-based-access-control.md b/docs/user/role-based-access-control.md index 3150fdc2f5..0ba6b73da2 100644 --- a/docs/user/role-based-access-control.md +++ b/docs/user/role-based-access-control.md @@ -1,5 +1,7 @@ --- navTitle: Role-Based Access Control +meta: + description: Control what team members can create, change, view or delete in FlowFuse with team-level roles and application-level overrides. --- # Role-Based Access Control diff --git a/docs/user/snapshots.md b/docs/user/snapshots.md index 7d65de5812..23c21d76f8 100644 --- a/docs/user/snapshots.md +++ b/docs/user/snapshots.md @@ -1,5 +1,7 @@ --- navTitle: Snapshots +meta: + description: Create, restore, compare and download snapshots, the point-in-time backups of a Node-RED instance's flows, credentials, settings and packages. --- # Snapshots From b93e5e1e6121bbfb5d5adc9964cbc57a385528f4 Mon Sep 17 00:00:00 2001 From: Dimitrie Hoekstra Date: Tue, 29 Sep 2026 14:02:45 +0200 Subject: [PATCH 3/3] docs: link the MCP nodes at their /docs URL 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. --- docs/user/expert/chat.md | 2 +- docs/user/expert/third-party-agents.md | 2 +- docs/user/mcp.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user/expert/chat.md b/docs/user/expert/chat.md index 24ca4b0362..c6adb2b6a4 100644 --- a/docs/user/expert/chat.md +++ b/docs/user/expert/chat.md @@ -251,7 +251,7 @@ If the Expert starts giving unexpected or inconsistent answers, it may be due to **Insights mode** connects the Expert to your live data via **Model Context Protocol (MCP)**. Use it when you want to query, analyze, or interact with real-world data - not just your Node-RED flows. -In Insights mode, you first select an MCP Server that you've built using [FlowFuse MCP Server Nodes](https://flowfuse.com/node-red/flowfuse/mcp/). The Expert can then use the tools and resources exposed by that server to answer questions against your live operational data. If you haven't built an MCP Server yet, see the guide on [building an MCP Server using FlowFuse](https://flowfuse.com/blog/2025/10/building-mcp-server-using-flowfuse/). +In Insights mode, you first select an MCP Server that you've built using [FlowFuse MCP Server Nodes](https://flowfuse.com/docs/flowfuse-nodes/mcp/). The Expert can then use the tools and resources exposed by that server to answer questions against your live operational data. If you haven't built an MCP Server yet, see the guide on [building an MCP Server using FlowFuse](https://flowfuse.com/blog/2025/10/building-mcp-server-using-flowfuse/). As of v2.32, Insights mode also reaches your **remote instances** at the edge, not just hosted instances. Point the Expert at a remote instance and ask about its live machine or operational data in plain language, with no dashboard to build and no query to write. diff --git a/docs/user/expert/third-party-agents.md b/docs/user/expert/third-party-agents.md index 3ad7619705..352d409791 100644 --- a/docs/user/expert/third-party-agents.md +++ b/docs/user/expert/third-party-agents.md @@ -41,7 +41,7 @@ The same three steps, written out: Your agent is now connected. If your client does not support OAuth, use a token instead, see [clients without a sign-in flow](#clients-without-a-sign-in-flow). -> **Note:** This is separate from [MCP server nodes](https://flowfuse.com/node-red/flowfuse/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client. +> **Note:** This is separate from [MCP server nodes](https://flowfuse.com/docs/flowfuse-nodes/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client. ## What your agent can do diff --git a/docs/user/mcp.md b/docs/user/mcp.md index c03ef2d4c1..1fc6d2f771 100644 --- a/docs/user/mcp.md +++ b/docs/user/mcp.md @@ -15,7 +15,7 @@ Two clients use it: Both use the same capabilities. What an agent can do depends only on the access you grant. -> **Note:** This is not the same as [MCP server nodes](https://flowfuse.com/node-red/flowfuse/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client. +> **Note:** This is not the same as [MCP server nodes](https://flowfuse.com/docs/flowfuse-nodes/mcp/), which build MCP servers inside your flows. This page is about operating FlowFuse itself, where FlowFuse is the server and your agent is the client. ## Platform Automations