Skip to content

handbook: point Edit this page at Studio - #5690

Open
dimitrieh wants to merge 2 commits into
mainfrom
handbook/edit-link-studio
Open

handbook: point Edit this page at Studio#5690
dimitrieh wants to merge 2 commits into
mainfrom
handbook/edit-link-studio

Conversation

@dimitrieh

@dimitrieh dimitrieh commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Description

Handbook pages carry an "Edit this page" link, and the handbook tells everyone it opens our CMS and needs no git knowledge. It actually opened GitHub's file editor. This points it at Studio on the page you are reading, and keeps GitHub as a second link for anyone who prefers it.

CleanShot 2026-08-27 at 12 26 06@2x
Link in the handbook sidebar Before After
Edit this page GitHub file editor Studio, on the page you are reading
GitHub not offered one click away

If you are already signed in, the editor appears on the page. If not, you sign in with GitHub and come back to that same page.

Docs pages and the Node-RED guides keep their GitHub links on purpose. Docs text lives in the FlowFuse/flowfuse repository, and the guides are not Nuxt pages, so Studio cannot open on either.

Two handbook sentences also still pointed at the old src/handbook/ folder, which moved to nuxt/content/handbook/. Corrected.

Related Issue(s)

None.

Checklist

  • I have read the contribution guidelines
  • I have considered the performance impact of these changes
  • Suitable unit/system level tests have been added and they pass
  • Documentation has been updated
  • For blog PRs, an Art Request has been created (instructions)

The handbook tells everyone that Edit this page opens Nuxt Studio and needs no git
knowledge, but the link opened GitHub's file editor. Point it at the Studio route
instead, carrying the current path in ?redirect= the way Studio's own shortcut does,
so a signed-in visitor gets the editor on the page they are reading and everyone
else signs in and comes back to it. GitHub stays available as a second link.

The route comes from the module's runtime config rather than a repeated literal.

Docs pages keep their GitHub link: that markdown lives in FlowFuse/flowfuse, which
Studio is not configured for. The Node-RED and hardware guides keep theirs too,
since they are still 11ty pages and carry no Nuxt app for Studio to mount on.

Also corrects two handbook references to src/handbook/, which moved to
nuxt/content/handbook/ during the migration.
@dimitrieh
dimitrieh requested a review from ZJvandeWeg August 27, 2026 10:24
@dimitrieh

Copy link
Copy Markdown
Contributor Author

@ZJvandeWeg came across this while looking into how we can schedule multiple things hitting the website together for a release. The "edit this page" is essentially not even needed anymore as nuxt pages get this in the bottom left corner:
CleanShot 2026-08-27 at 12 25 16@2x

@netlify

netlify Bot commented Aug 27, 2026

Copy link
Copy Markdown

Deploy Preview for flowforge-website ready!

Name Link
🔨 Latest commit 4502b69
🔍 Latest deploy log https://app.netlify.com/projects/flowforge-website/deploys/6a9016256e1655000897ef9b
😎 Deploy Preview https://deploy-preview-5690--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.

hyperlink, the link checker in the shared build workflow, reads /_studio as a broken
link because that route has no prerendered file, and the tool takes no ignore list.
pages/docs/[...slug].vue already keeps its edit link out of the static HTML this way.
@ZJvandeWeg

ZJvandeWeg commented Aug 27, 2026

Copy link
Copy Markdown
Member

This depends on: https://github.com/FlowFuse/website/pull/5694/changes
The 'live' branch being present and the deploy base messes with Nuxt Studio.

Reason is, that Nuxt Studio doesn't support feature branches. And if you now edit with Nuxt studio, you'll publish to live which is never merged back to main

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