Repository navigation
feat(docs): split the Dialog page into an overview and a page per layer - #61
Merged
Merged
Conversation
The Dialog's page becomes a folder shaped like the Button's: an Overview, a page for each layer, and its own group in the sidebar. The text moved as it was, apart from link targets, the cards in place of the intro's list of layers, At a glance starting before the paragraph on examples, and the list of the four checklists. Co-authored-by: multica-agent <github@multica.ai>
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://dialog-sub-pages-uxf-428-opencomponents.blue-water-0397.workers.dev (commit 30c36b9)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
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
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 changed
The Dialog's page becomes
content/docs/3.components/dialog/, shaped like the Button's: an Overview inindex.md, then a page per layer, User Interface (UI), User Experience (UX), Developer Experience (DX) and Agentic Experience (AX), and a.navigation.ymlthat names the group and keeps the page's icon. It doesn't change what the standard says, so it isn't a guideline change for any one layer.The Overview keeps the intro, At a glance, the Checklist's intro, the reference implementation and the sources. Four cards link the layer pages in place of the intro's list of layers, each with its page's new one-line description. At a glance now starts before the paragraph on how the examples work, then the paragraph on why the Dialog is modal, the playground and the table. Each layer page has its sections a level higher, then its rules under "UI Checklist" and so on, then its questions. Links to the page's own sections go to the layer page that now has them, like
/docs/components/dialog/ux#every-state. No other text changed.The FAQ's questions went to the layer each one answers:
The live examples are on the Overview (the playground), User Interface (two) and User Experience (one). Developer Experience and Agentic Experience have none, like the Button's.
Agents still read one page.
/raw/docs/components/dialog.mdhas the same headings in the same order as before, with the same rules, and/raw/docs/components/dialog.yamlis the same contract apart from link targets.Checklist
feat(docs): add the focus guideline.pnpm check-typespasses.pnpm dev. (Checked on the built site throughwrangler devinstead: the sidebar, the header's menu, the previous and next links, every live example, the Framework select and the links from before the split.)pnpm build, thenpnpm lighthouse, still scores 100 in every category. (No homepage changes.)