docs: rework structure and flow around the standard-handler narrative - #272
Merged
Conversation
Reorganize the documentation to follow the define-once/mount-anywhere story: one definition, one standard handler, adapters as conveniences, visual and agentic, then composing a hub and inheriting the ecosystem. - Reframe the landing page and guide introduction around this narrative. - Elevate initDevframe() as 'The Standard Handler' — the boundary every serving path is built on — and position adapters as conveniences over it. - Regroup the guide sidebar/nav into narrative sections (Define your tool, Mount anywhere, Visual & agentic, Compose a hub, Customize the UI). - Fix stale claims: RPC is validated against any Standard Schema validator (not 'birpc + valibot'), and the hosted default base is /__<id>/. Created with the help of an agent.
✅ Deploy Preview for devfra ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Aggressive concision pass over every non-error page: delete redundant rationale/background paragraphs, restatements of adjacent code and tables, and duplicate examples; collapse multi-sentence explanations. Total markdown drops from ~64.5k to ~46.9k words (~73% of the original). Preserved throughout: all code blocks, tables, warnings/callouts, links, heading anchors, and technical facts (API names, defaults, error codes, versions). Error reference pages (docs/errors/*) are left untouched. Created with the help of an agent.
antfu
reviewed
Aug 21, 2026
- Restore the Nitro, Nuxt, and SvelteKit mount examples in the standard handler page. - Rename the guide nav group to 'Agentic'. - Drop the deprecated `def.cli?.distDir` fallback note from the build adapter. - Consolidate examples into a single guide/built-with page (Real-world DevTools / Builtin Plugins / Playable Examples) and remove the per-example docs pages; example READMEs serve that purpose. Repoint links accordingly. - Rework the Introduction to lead with what Devframe is, why it exists, and who it is for before the technical details. Created with the help of an agent.
antfu
reviewed
Aug 21, 2026
- Add the intro point that, with agents, Devframe is a fast foundation for bespoke or one-off devtools (addresses review comment on the introduction). - Fix the stale hosted-base default in the definition reference (/__<id>/) and drop the remaining deprecated cli.distDir mentions. - Continue the concision pass across the guide, adapters, frameworks, plugins, and helpers, bringing total markdown to ~65% of the original while preserving code, tables, warnings, links, and technical facts. Created with the help of an agent.
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
2 participants
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.
What & why
Reworks the documentation structure and flow so the docs tell the same story as the Pluggable, Extensible, and Playful DevTools article: build a devtool once, then mount it anywhere.
Previously the landing page and guide led with a CLI-first, "Devframe is an asset" framing, and
initDevframe()— the actual portability boundary — was buried as one entry in the adapters list. This reorganizes everything around the narrative spine the article uses.Changes
docs/index.md): new hero and six features following the arc — one definition/one standard handler → adapters as conveniences → type-safe RPC & shared state → visual and agentic → from one devframe to a hub → built-in plugins across frameworks.docs/guide/index.md): rewritten as a narrative — the shared boundary, one definition/one standard handler, adapters as conveniences, visual and agentic, from one devframe to a hub, inheriting the ecosystem — then install, hello-world, and a reference table.docs/adapters/initiate.mdis retitled and reframed as the boundary every serving path is built on;docs/adapters/index.mdnow positions adapters as conveniences over it and leads its comparison table with the handler.docs/.vitepress/config.ts): guide regrouped into narrative sections — Introduction, Define your tool, Mount anywhere, Visual & agentic, Compose a hub, Customize the UI — and the adapters list leads with the Standard Handler.Accuracy fixes found along the way
devframe)./__<id>/(the guide intro previously said/.<id>/).Validation
pnpm run docs:buildpasses (VitePress dead-link checking is active and reports none).This PR was created with the help of an agent.