ContributingDocs site
Where the code is
Seven folders of docs/ hold the pages, the components, the scripts and the app.
The folders
| Path | Contains |
|---|---|
app/ | The landing page, the docs layout and page, the 404 page (not-found.tsx), the search index, Open Graph images and global.css. Also Markdown versions of the pages for LLMs (llms.txt, llms-full.txt). |
components/layout/ | The site header with the Light / Dark / System theme menu, the docs header slot and the sidebar. Also the section links that show in the sidebar and in the mobile drawer below lg. |
components/ | The search dialog (search.tsx): it ranks first the pages whose title or headings match. The API page renderer (api-page.tsx): it adds the Authorization header to the request samples. |
components/mdx/ | Callout, Cards, Badge, Mermaid and the figures (Diagram, Flow, Terminal, Term). components/mdx.tsx is the MDX component map. |
content/docs/ | The pages |
lib/ | The content source, the OpenAPI loader and shared settings |
scripts/ | generate.mjs, check-links.mjs, and check-ste.mjs with check-figures.mjs (npm run check-content) |
The component map gives each MDX page its components with no import.