docs: adopt Fumadocs components for clarity (highlights, Tabs, Steps, TypeTable, Accordion)#186
Merged
Merged
Conversation
… TypeTable, Accordion) Five clarity wins across the Actio docs: - Code highlighting ([!code highlight]) on synthesized lines in CodeCompare generated panes across 11 macro pages, so it's obvious what each macro adds. - Tabs (ts/js/json) in configuration.mdx #config-formats. - Steps in quickstart.mdx (init->build->check) and supply-chain.mdx two-phase flow. - TypeTable for macro option lists (retry, fallback; soft-fail pre-existing). - Accordion in out-of-scope.mdx collapsing issue lists under each cause (H2s kept). Registration in docs/components/mdx.tsx is additive (Accordion/Accordions, Step/Steps). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…components-audit # Conflicts: # docs/content/docs/configuration.mdx
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.
What
Five green-lit Fumadocs UI adoptions to sharpen the docs message. Implements the audit proposal (
fumadocs-component-audit.md).Changes
[!code highlight]markers on the synthesized lines inside CodeCompare "generated.yml" panes across 11 macro pages (retry, fallback, soft-fail, dynamic-matrix, if-changed, share, ref, injection-hoist, lifecycle, expand-matrix). Makes it visually obvious what each macro injects vs. what you wrote. Headline win.ts/js/jsonexamples inconfiguration.mdx#config-formats (registeredTabs/Tab, not the codeblocktab=variant).quickstart.mdxinit→build→check, andsupply-chain.mdx's two-phase pattern.retry+fallback(soft-fail already had one).out-of-scope.mdxcollapses the issue lists under each numbered cause; H2 headers + "Why not" kept visible.Registration (
docs/components/mdx.tsx)Purely additive:
Accordion/Accordions+Step/Stepsimports and return-object entries. No removals; existing entries untouched.Gates
npm run docs:build— green (503/503 static pages)npm test -- docs-completeness syntax-reference macros— 84/84 passinghighlightedclass), zero literal[!code highlightleaks (markers strip cleanly even acrossrun: |-block scalars).Merge reconciliation (three-way hotspot)
docs/components/mdx.tsxis touched by two other in-flight workstreams. My append is additive and should merge cleanly with:File/Files/Folderregistration +<Files>trees in quickstart/configuration/templates) — left untouched here; my Steps/Tabs edits sit in different regions of those files.source.config.ts+ Popup components) —source.config.tsnot touched by this PR.Draft until the above land and the registry is reconciled.
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com