This starter is designed for teams that want a documentation site to feel composed from day one. The structure stays intentionally compact, but the content model is solid enough to grow with a real product later.
What ships in the box
The first version keeps the moving parts narrow on purpose:
- a branded landing page at
/ - a dedicated guides collection at
/docs - a dedicated reference collection at
/reference - markdown pages with shared frontmatter
- a generated sidebar and page-level table of contents
- static output through Void's
output: "static"mode
Route map
| Route | Purpose |
|---|---|
/ |
Introduces the starter and points visitors into the docs. |
/docs |
Sets expectations for the site structure and authoring model. |
/docs/getting-started |
Explains the project shape and first edits. |
/docs/installation |
Covers local setup and dependency choices. |
/docs/content-authoring |
Documents the markdown contract and writing habits. |
/docs/guides |
Demonstrates a nested docs folder with its own landing page. |
/docs/guides/sidebar-nesting |
Shows a child page inside the nested docs group. |
/docs/deployment |
Shows how to build and publish the static output. |
/reference |
Introduces the API-oriented content collection. |
/reference/authentication |
Describes auth expectations for requests. |
/reference/request-format |
Shows the expected payload shape. |
/reference/errors |
Lists error conventions and recovery hints. |
How content is organized
Each content page uses the same small frontmatter contract:
---
title: Getting Started
description: Launch the starter locally and make your first edit.
section: Start Here
order: 2
---
Those fields are enough to power the page title, description, section grouping, sidebar order, and static metadata in both collections. Nested folders also work, so you can group related pages into collapsible sidebar sections.
Suggested next steps
Once the starter feels right in your project, the usual upgrades are straightforward:
- Replace the placeholder copy with product-specific documentation.
- Expand either collection with product-specific sections once the information architecture settles.
- Add search or versioning only after the content model has settled.
For the practical first steps, move on to Getting Started or browse the Reference overview.