This starter is intentionally small, so the quickest way to get oriented is to understand which files define structure and which files hold content.
What to look at first
The starter is split into a few clear layers:
pages/[locale]/index.tsxholds the landing page implementation, whilepages/index.tsxkeeps the default-locale alias.pages/[locale]/docs.tsxandpages/[locale]/reference.tsxhold the collection overview implementations.pages/[locale]/docs/[...slug].tsxandpages/[locale]/reference/[...slug].tsxare the shared React routes for individual content pages.- each
[...slug].server.tsfile handles prerender paths and per-page head metadata. src/content/docs/**/*.mdcontains guide content, including nested folders.src/content/reference/**/*.mdcontains API-oriented content.src/components/docs-page.tsxbridges the current route to the right markdown page.src/components/docs-shell.tsxcontrols the shared docs layout.src/collections/collection.tsbuilds the metadata, sidebar groups, headings, and prev/next links for each collection.void.config.tscontrols static output and default metadata.
Run it locally
Use the standard Vite+ flow:
vp install
vp dev
Then open:
http://localhost:5173/http://localhost:5173/docs
Make your first edit
A good first pass is to edit one markdown file and one layout file:
- Update a page in
src/content/docs/to change the actual documentation copy. - Add a page in
src/content/docs/guides/if you want to test nested sidebar groups. - Add a page in
src/content/reference/if you want to expand the reference section. - Tweak
src/components/docs-shell.tsxif you want the sidebar, heading area, or table of contents to feel different.
This separation keeps content edits lightweight while leaving the visual system centralized.
What to avoid early
It is tempting to add search, auth, API routes, or dynamic examples immediately. Resist that for the first pass. A docs site gets easier to maintain when the information architecture becomes stable before the feature list expands.
When you are ready to change how docs are written, continue with Content Authoring.