docs: restructure nav into Guide/Adapters/Helpers, minimize READMEs#7
Merged
Conversation
- Split docs/guide/adapters.md into per-adapter pages under docs/adapters/ with an overview index, comparison table, and mount-paths reference. - Promote helpers to their own section under docs/helpers/ — move utilities and Nuxt module pages, lift Vite bridge out of adapters, and expand the open-helpers recipe into a standalone reference. - Rebuild .vitepress/config.ts nav/sidebar with the three top-level sections; add a version dropdown that reads from packages/devframe package.json and links to Release Notes + Contributing. - Add a full favicon head set (icon, apple-touch-icon, mask-icon, theme-color) using the sage brand color. - Add a "Built with Devframe" section to the home page covering Vite DevTools, ESLint Config Inspector, node-modules-inspector, and the three local examples. - Minimize root and packages/devframe READMEs to logo + badges + tagline + docs link, pointing readers at https://devfra.me/.
✅ Deploy Preview for devfra ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
… diagram - Move the "Built with Devframe" list from the home page to the end of the introduction so it lives alongside related guide content. - Remove the architecture mermaid diagram from the introduction — the subsystems table and adapters-at-a-glance section already cover the same ground.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/guide/adapters.mdinto per-adapter pages underdocs/adapters/and promote helpers (utilities, Vite bridge, Nuxt module, open-helpers recipe) to their owndocs/helpers/section. VitePress nav/sidebar are rebuilt around Guide / Adapters / Helpers / Errors, plus a version dropdown reading frompackages/devframe/package.jsonthat links to Release Notes and Contributing.headset in the VitePress config —icon,apple-touch-icon,mask-icon, and a sagetheme-colormeta.packages/devframeREADMEs down to logo + badges + tagline + docs link —https://devfra.me/is now the source of truth.Test plan
pnpm docs:build— clean, no dead linkspnpm lintandpnpm typecheck— cleanpnpm test— 283/283 passing