docs: split guide lookup tables into grouped reference pages - #313
Merged
Conversation
Follow the Divio documentation system: guide pages teach with prose and code examples; lookup tables (fields, options, enums, statuses, routes) move to three new grouped reference pages — Node-Side API, Browser-Side API, and Hub API. Each guide keeps a prose summary of the essentials plus a link to its reference section; comparison and decision tables stay in the guides as explanation. Codify the split in AGENTS.md.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Intent
Adopt the Divio documentation system's separation of learning material from lookup material across the docs.
docs/content/1.guide/(definition fields, options, enums, statuses, event lists, route tables — 30 tables across 14 pages) moves out; each guide keeps a one-or-two-sentence prose summary of the essentials plus a link to its reference section.connectDevframeoptions, RPC client events, connection statuses, in-page channel error codes), and Hub API (subsystems, launcher fields, duplication strategies, dock categories, hub UI protocol, namespace routes, client runtime, client context, dock entry types). Each section opens by naming what it lists and linking the guide that teaches it.All moved anchors were verified against
github-slugger(what comark uses for heading ids);pnpm lintand the docs build pass.This PR was created with the help of an agent.