Background & Goal
Currently, the component pages in Codex incorporate Guidelines, Demos, Vue usage, and CSS-only on a single lengthy page, presenting the following problems:
- Lengthy pages can be overwhelming for users.
- Navigation is unclear, making it difficult for designers or developers to find relevant information.
- Duplication of information between Guidelines and Demos leads to confusion.
- Some demos are duplicated between the "Demos" and "CSS-only version" sections.
User stories
- As a designer, I need to quickly locate design-related details and best practices on the component page.
- As a developer, I need to easily access coding information and also learn about best practices for implementing the component.
- As a Codex user (e.g., PM), I need easy access to all component-related information on the component pages.
Open questions
Design proposal
We will use Tabs to organize the content on the components pages effectively:
- "Guidelines" tab will host design-focused content, including existing guidelines and new content migrated from Figma spec sheets.
- "Code" tab will contain development-related content, including Vue demos and CSS-only demos.
Acceptance criteria for Done
- Explore design solutions to improve the navigation and consultation of components page in Codex
- Review the proposals with the DST and decide on the best solution
Future tasks
- T358798: docs: Explore supporting tabbed subpages of the component pages
- T358854: docs: Decide on the placement of the configurable demo on the tabbed component pages
- Update the component's page in the Codex site with the decision (File task)