docs(tokens): add Diátaxis documentation for grid, spacing, typography, and cascade layers#550
Open
docs(tokens): add Diátaxis documentation for grid, spacing, typography, and cascade layers#550
Conversation
…y, and cascade layers Add 10 new MDX documentation files following the Diátaxis framework: Explanations: - GridSystem.mdx: why responsive vs intrinsic, modifier pattern, subgrid - SpacingScale.mdx: 8px base unit, rem rationale, baseline grid How-to guides: - HowToUseResponsiveGrid.mdx: breakpoint-driven column layouts - HowToUseIntrinsicGrid.mdx: fluid content-driven layouts - HowToForceTheme.mdx: dark/light subtree override - HowToDebugTokens.mdx: DevTools token tracing - HowToAlignBaseline.mdx: baseline grid alignment Tutorial: - TutorialFirstGrid.mdx: guided dashboard layout build Reference: - GridReference.mdx: all grid classes, custom properties, breakpoints - CascadeLayersReference.mdx: 5-layer cascade architecture with channels Also adds SpacingScale and TypographyScale story exports to Tokens.stories.tsx and restructures the hub Introduction.mdx to surface the Diátaxis navigation map.
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.
Done
SpacingScaleandTypographyScalestory exports toTokens.stories.tsxIntroduction.mdxto surface the Diátaxis navigation mapNew documentation files
Explanations
GridSystem.mdx— why responsive vs intrinsic, modifier pattern in the grid, why subgridSpacingScale.mdx— 8px base unit, half-step refinements, rem rationale, baseline grid relationshipHow-to guides
HowToUseResponsiveGrid.mdx— 5-step breakpoint-driven column layout recipeHowToUseIntrinsicGrid.mdx— 4-step fluid content-driven layout recipeHowToForceTheme.mdx— 5-step dark/light subtree overrideHowToDebugTokens.mdx— 6-step DevTools token tracingHowToAlignBaseline.mdx— 5-step baseline grid alignmentTutorial
TutorialFirstGrid.mdx— 7-step guided dashboard layout buildReference
GridReference.mdx— all grid classes, custom properties, breakpoints, browser supportCascadeLayersReference.mdx— the 5-layer cascade architecture with all modifier channelsNew story exports
SpacingScale— visual bar chart of all 17 dimension tokens with rem/px values and baseline-grid markers, common spacing patterns, and aTokenTableexplorerTypographyScale— live-rendered heading 1–6 previews, text primary/secondary/tertiary with bold variants, and a 5-token structure referenceHub update
Introduction.mdx— added Diátaxis navigation map (🎓 Learn / 🔧 How to / 💡 Understanding / 📖 Reference), corrected modifier ontology to four axes (Importance, Anticipation, Criticality, Emphasis)QA
nx storybook ds-tokensand verify all new stories render without errorsnx storybook storybook-huband verify the updated Introduction page renders the Diátaxis navigation mapPR readiness check
Feature 🎁,Breaking Change 💣,Bug 🐛,Documentation 📝,Maintenance 🔨.package.json:check,check:fix, andtest.buildto build the package for development or distribution,build:allto build all artifacts.Screenshots
N/A — documentation-only change, no visual component changes.