Conventions for scaffold pages in the design library gallery.
Problem
During POC development, routes were created for every planned gallery section — including categories with no implemented components yet. Showing these in the sidebar creates dead clicks that erode trust.
Policy
Sidebar (libraryNav.ts)
Only list routes that have real, intentionally implemented content.
Placeholder pages must NOT appear in the sidebar. The comment block at the top of libraryNav.ts documents currently excluded entries.
Route files
Do not add scaffold “Coming Soon” pages. Either implement the real gallery page or omit the route until content exists.
Section hubs that appear in navigation should redirect to the first implemented doc page (same pattern as feedback-indicators/page.tsx).
When to add a route
- A gallery category has at least one implemented component page ready for nav
When to remove a route
- The real page is implemented elsewhere → replace with a redirect or delete the orphan path
- The section is cancelled → delete the route entirely
When to add to navigation
All three must be true:
- A gallery page component exists with real content (not a redirect stub)
- The component is exported and functional in
@spring/ds-react(for component pages) - manual QA or manual QA confirms the page renders correctly
Currently Excluded from Nav (no route until implemented)
| Section | Notes |
|---|---|
| Design Tokens → Layout | Add /library/design-tokens/layout when token docs exist |
| Components → Layout and Structure | Reserved in package; no app route yet |
| Components → Image and Icons | Reserved in package; no app route yet |
| Components → Lists | Reserved in package; no app route yet |
| Components → Tables | Reserved in package; no app route yet |
| Design Libraries | Reserved in package README; gallery routes added when product libraries ship |
Empty Package Directories
Reserved component categories in packages/spring-ds-react/src/components/ have README stubs explaining they are placeholders for future Figma → code targets. Do not delete these directories — they define the gallery category structure.