Skip to content

app-guide: link component call-outs to the docs - #5723

Open
dgatti0213 wants to merge 1 commit into
mainfrom
handbook/app-guide-updates
Open

app-guide: link component call-outs to the docs#5723
dgatti0213 wants to merge 1 commit into
mainfrom
handbook/app-guide-updates

Conversation

@dgatti0213

@dgatti0213 dgatti0213 commented Sep 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What & why

On the Application Guide's Foundations and App delivery methods pages, the components we name (Snapshot, Pipeline, Instances, etc.) were plain bold text. This links each call-out to its docs reference so a reader can jump straight from the concept to the details.

Changes

  • Foundations — Instances, Device Agent, Team Broker, Database (Tables), Dashboards → the Dashboard 2.0 docs (dashboard.flowfuse.com), Edge & device management.
  • App delivery methods — Snapshot, Pipeline, Dev/Remote/Hosted Instances, Team Library, Bill of Materials, Custom node, and Subflow → a new /docs/user/packaging-subflows/ page.

@dgatti0213 @claude
app-guide: link component call-outs to the docs
a98e47c 
On Foundations and App delivery methods, the components we name (Snapshot,
Pipeline, Instances, Team Broker, Tables, Dashboards, Device Agent, Team
Library, Bill of Materials, Subflow, Custom node) were plain bold text.
Link each to its docs page so readers can jump straight to the reference.

- Dashboards -> the Dashboard 2.0 docs (dashboard.flowfuse.com)
- Subflow -> a new /docs/user/packaging-subflows/ page (added separately in
  flowfuse/flowfuse); this PR stays draft until that doc lands.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CVTs4TWBz2sVJ3k55ZHUg8
@dgatti0213

dgatti0213 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

🔎 What changed — pages to review

Live on the Netlify Deploy Preview once it builds:

Updated pages

Page Preview Newly-clickable components
Foundations /application-guide/flowfuse/foundations/ Instances, Device Agent, Team Broker, Database, Dashboards (→ dashboard.flowfuse.com), Edge & device mgmt
App delivery methods /application-guide/flowfuse/app-delivery-methods/ Snapshot, Pipeline, Instances, Team Library, Bill of Materials, Custom node, Subflow (→ new docs page)

Docs-only content change (no component/logic changes).

⚠️ Blocked on a docs PR — please review but hold merge. The Subflow link targets /docs/user/packaging-subflows/, a new page landing in flowfuse/flowfuse (Subflow Packaging Sidebar; hosted-instance only). It 404s until that doc merges, so nuxt-link-checker may flag it in the preview. Merge this once the docs page is live.

@netlify

netlify Bot commented Sep 1, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for flowforge-website ready!

Name Link
🔨 Latest commit a98e47c
🔍 Latest deploy log https://app.netlify.com/projects/flowforge-website/deploys/6a96fb0b8b3f8f00070705a7
😎 Deploy Preview https://deploy-preview-5723--flowforge-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse		 1 paths audited
Performance: 64 (🟢 up 17 from production)
Accessibility: 96 (no change from production)
Best Practices: 100 (no change from production)
SEO: 85 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@dgatti0213 dgatti0213 mentioned this pull request Sep 1, 2026
Merged
@dgatti0213

dgatti0213 commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

📎 Docs dependency is now open: FlowFuse/flowfuse#8355 (adds /docs/user/packaging-subflows/, the target of the new Subflow link here). This PR should merge after that docs page lands.

@hardillb

hardillb commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

@dgatti0213 Upstream docs PR is merged, but looks like this one has got a little out of sync with the website. Let me know if you can't fix it and I'll see if I can have a look

This branch was successfully deployed

1 active deployment
Preview — a98e47ce Deployed Sep 1, 2026 by github-actions[bot]
View deployment
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@KristopherLeads KristopherLeads Awaiting requested review from KristopherLeads

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dgatti0213 @hardillb