Skip to content

Authoring

Contributors

Every product follows the same pattern, which is what lets a reader move between products without relearning the layout:

src/content/docs/<product>/
├── index.mdx the product overview, sidebar order 0
├── <subsection>/
│ ├── index.md the subsection overview
│ └── <article>.md
└── <subsection>/
└── ...

An overview page at every level. A reader who lands on a folder should get an orientation and a list of what is inside, not a redirect to the first article.

Product, subsection, article. Nesting deeper is possible and is almost always a sign the subsection is doing too much: split it into two rather than burying pages three clicks down.