Skip to content

Migrate docs to Nuxt via sparse clone of flowfuse/flowfuse at build time#5177

Open
ZJvandeWeg wants to merge 3 commits into
mainfrom
zj-docs-deploy-nuxt
Open

Migrate docs to Nuxt via sparse clone of flowfuse/flowfuse at build time#5177
ZJvandeWeg wants to merge 3 commits into
mainfrom
zj-docs-deploy-nuxt

Conversation

@ZJvandeWeg

Copy link
Copy Markdown
Member

Replaces the live-branch pipeline with a docs-source Nuxt module that sparse-clones docs/ from the public flowfuse/flowfuse repo on every build. Adds DocsLeftNav, useDocsNav, and docs/[...slug].vue reusing the handbook layout. Removes copy_docs.js, src/docs/, and all related 11ty wiring. Also adds ChecklistItem MDC component for upstream docs migration.

Related Issue(s)

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)

@ZJvandeWeg
ZJvandeWeg requested a review from dimitrieh June 10, 2026 17:53
@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

👷 Deploy Preview for flowforge-website processing.

Name Link
🔨 Latest commit 6b7a10a
🔍 Latest deploy log https://app.netlify.com/projects/flowforge-website/deploys/6a29a4b2dfffc60008d74180

@netlify

netlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Deploy Preview for flowforge-website ready!

Name Link
🔨 Latest commit 1562c46
🔍 Latest deploy log https://app.netlify.com/projects/flowforge-website/deploys/6a4e5d166015d80009f6ef06
😎 Deploy Preview https://deploy-preview-5177--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: 79 (🟢 up 14 from production)
Accessibility: 96 (no change from production)
Best Practices: 100 (no change from production)
SEO: 83 (🔴 down 8 from production)
PWA: -
View the detailed breakdown and full score reports

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

Replaces the live-branch pipeline with a docs-source Nuxt module that
sparse-clones docs/ from the public flowfuse/flowfuse repo on every build.
Adds DocsLeftNav, useDocsNav, and docs/[...slug].vue reusing the handbook
layout. Removes copy_docs.js, src/docs/, and all related 11ty wiring.
Also adds ChecklistItem MDC component for upstream docs migration.

@dimitrieh dimitrieh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some errors it seems:

CleanShot 2026-07-15 at 12 01 03@2x

and we might want to adjust the colors here for less contrast

CleanShot 2026-07-15 at 12 02 11@2x

Also search and ToC doesn't seem to work yet

CleanShot 2026-07-15 at 12 04 30@2x

@Yndira-E

Copy link
Copy Markdown
Contributor

Really like being able to see docs locally without cloning the repo, and in deploy previews, where it's currently not possible at all.

Seconding what @dimitrieh flagged, dug into the "errors" screenshot a bit further: the root cause is that docs/README.md (and a few other pages) embed raw HTML plus an inline <script> that defines a custom element (icon-chevron-right) for the card grid. markdown-it (11ty) passes that straight through, but @nuxt/content's parser doesn't render it the same way, the whole block falls back to literal escaped text, which is why it shows up as a misaligned "code block" instead of the tile grid.

A couple of other observations:

  • Right now, if the git clone in docs-source.ts fails (network hiccup, GitHub blip), the entire production build fails with no fallback. Worth adding some resilience here, either caching nuxt/content/docs as a fallback if the clone fails, or a simpler retry around the clone call, which would cover most transient network issues.
  • If we go for the cache route, incremental updates become possible too, but with the current doc volume (~112 files) this isn't critical, more of a nice-to-have.
  • Similarly, incremental refresh in local dev (right now it's "delete the folder or set FLOWFUSE_DOCS_LOCAL") would be nice for DX, but also not critical.

Once Algolia search, the right-hand ToC, and the other rendering issues Dimitrie called out are sorted, I'm happy to do a final CSS pass to make sure everything's visually consistent with the rest of the site.

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.

3 participants