Background/Goal
The structure of the Introduction and the Contributing sections in the Codex demo should be updated in order to make room for and properly organize the guidelines and supporting documentation that will be created as part of T313905: Governance & Guidelines: Publish Guidelines & Documentation required for Design System Contribution V1.
Our suggestion is to create clearly targeted sections in the left navigation menu that map to the informational needs of Codex users (consumers and contributors). Here's our initial proposal:
Using Codex
About Codex
- What is Codex? (Contains the information currently available in "About", but not the Guiding principles – see below)
- Who is Codex for? (Would contain the "Who we're serving" and "Collaboration principles" section of the guidelines and the "Usage and contributions" section in About)
Developing
- How to use Codex (Contains the "Usage" section)
- Packages (Contains the information already included in the "Packages" section)
Designing
- Design principles (Hosts the content to be created as an outcome of T313933)
- Design resources (links to the Figma resources: design components' library, iconography, and tokens)
Decisions – ADRs
Contributing
- Overview
- Governance model (Name TBD to make it more understandable: Maybe "Contribution workflow"?. See graphic to be textually described in this section)
- Contributing code (This page should contain the "Code design patterns" from our Guiding principles, all sections currently included in "Contributing Code" + "Working with TypeScript" + "Adding new icons", which is currently a subsection of "Icons")
- Contributing design (Will contain the sections "Designing tokens", "Designing components" (See T312023) and "Designing Icons" (See T312025))
Acceptance criteria
- The DST agrees on the new structure and content of our introduction and documentation sections
- The agreed-upon structure is reflected in the Codex demo, and the content is reorganized when needed
