FlowFuse / FlowFuse/website

[Content Migration] Migrate Documentation to Nuxt Content

Open
#4,873 0 comments 0 reactions 0 assignees View on GitHub
story
Dominant language
Vue
Stars
23
Forks
19
Avg merge
2d 5h
Merged PRs (30d)
146

Description

### Epic

4867

### Description

## Objective
Migrate the `/docs` section from 11ty to Nuxt. Given the complexity of documentation, we will utilize Nuxt Content's document-driven mode or custom Vue layouts.

## Tasks
- [ ] Recreate the documentation layout, including the sidebar navigation and table of contents, using Vue components.
- [ ] Move 11ty copy_docs.js logic to a Nuxt's git import to `content/docs/` directory.
- [ ] Update code highlighting configurations (migrate to Nuxt Content's Shiki integration).
- [ ] Ensure any interactive Vue components used in our main app can now be embedded directly in the docs markdown.
- [ ] Delete legacy docs from 11ty and remove Nuxt proxy rules for `/docs/**`.

## Acceptance Criteria
- Docs are served by Nuxt.
- Code snippets are highlighted correctly.
- Main app Vue components can be rendered inside the docs markdown.

### Acceptance Criteria

_No response_

### Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.