Repository navigation
feat(docs): split the Spinner page into an overview and a page per layer - #63
Merged
Merged
Conversation
The Spinner page becomes a folder shaped like the Button's: an Overview with a card per layer, and a page each for UI, UX, DX and AX, with that layer's rules and questions. The text moves as it is. Links to the page's own sections now go to the part that holds them. Co-authored-by: multica-agent <github@multica.ai>
…o split-spinner-uxf-431
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://split-spinner-uxf-431-opencomponents.blue-water-0397.workers.dev (commit 38cc8eb)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 Spinner page is now a folder shaped like the Button's, so readers get a page per layer rather than one long page. The Overview keeps the intro, At a glance, the Checklist's intro, the reference implementation and the sources, and links each layer from a card. The UI, UX, DX and AX pages hold their sections, then their rules under
## <Layer> Checklist, then their questions. The text moves as it is: agents still read one page at/raw/docs/components/spinner.md, with the same outline, rules and contract as before, and old links like/docs/components/spinner#every-statego on to the right part.Links on the Spinner's own pages to its own sections now point to the part that holds them. Links to other components' sections, and other pages' links into the Spinner, are left for the layer that links the split pages to each other.
Each FAQ item went to the layer it answers:
The live examples went with their sections: one on User Interface and one on User Experience. The Spinner has no playground, so the Overview has none, and neither do the Developer Experience and Agentic Experience pages.
Checklist
feat(docs): add the focus guideline.pnpm check-typespasses.pnpm dev. (Read on the built site served bywrangler devinstead, with Chrome at 1440px and 375px.)pnpm build, thenpnpm lighthouse, still scores 100 in every category. (No homepage changes.pnpm lighthousepasses the 0.95 budget, with Best Practices at 0.96.)