Docs that quietly go stale
Your docs live in an external CMS with no link to the code. You rename a feature, ship it, and the public docs describe the old one for months. Here, docs live in the repo and change in the same pull request.
Lever elke weekUI and contentdocumentation
Docs-site inbegrepen
Een documentatiesite waar je meteen in kunt schrijven.
Een documentatiesite waar je meteen in kunt schrijven.
- 14 docs pages ready to edit
- 5 grouped sections in the sidebar
- 0 CMS services to run
5 van 6 in Lever elke week
Hoe het werkt
Het mechanisme van begin tot eind, zoals het in de repository is geïmplementeerd.
- 1
Write the page as typed content
Add or edit a page in one content file with its title, slug, and sections. No markdown pipeline, no file-system magic.
- 2
Place it in the menu once
Each page slug appears exactly once in the category list. That one placement sets its group and reading order.
- 3
Everything else derives
The index, sidebar, Cmd+K search, page metadata, and next/previous links are all computed from that list at build time.
- 4
Tests guard the structure
If a page is missing from the menu or listed twice, the build fails. Structure and content can't fall out of sync.
Interactief voorbeeld
Bekijk het in werking
Deze rondleiding toont het geïmplementeerde backendcontract zonder account, credentials of providercalls.
Interactief voorbeeld
Explore the implemented decisions
Local and provider evidence
Alleen deterministische voorbeelddata. De interactie gebruikt geen account-, provider- of netwerkverbinding.
Het probleem dat dit oplost
Zonder een gedeelde basis bouwt elk team deze randgevallen opnieuw — en anders.
A whole CMS for fourteen pages
You just wanted product docs. Now you're managing CMS credentials, webhooks, and an editorial pipeline before page one is live. Here, there's nothing to host: docs compile with the app.
The sidebar nobody trusts
Each page hand-lists its neighbors. Someone adds a page, forgets the links, and now the sidebar and the next buttons disagree. Here, one list drives all of it, and tests fail when it's wrong.
Kernpunten
Waarom dit belangrijk is
One list runs everything
Pages and their order live in one typed file. The sidebar, search, and next/previous links all derive from it automatically.
Reader comforts included
Cmd+K search, a table of contents, reading progress, mobile navigation, and feedback ship working, not as a to-do list.
The menu can't lie
Tests fail the build if a page is missing from navigation or listed twice, so the docs structure never quietly drifts.
Technische garanties
Wat dit wel en niet belooft
Veiligheidsgrens
Achter de schermen houden autorisatie, tenantgrenzen en foutafhandeling één duidelijke eigenaar. Zo blijft de snelle ervaring voor gebruikers gekoppeld aan veilig herstel als het misgaat.
Implementatiebewijs
De grens hierboven is geen claim maar code. Deze bestanden dragen het contract:
src/modules/docs/content.tssrc/modules/docs/DocsSearch.tsxsrc/routes/_public/docs
Vragen
Veelgestelde vragen
Verwante functies
Deze functies delen contracten en grenzen met deze pagina.
Bouw verder op Docs-site inbegrepen
De documentatie beschrijft dezelfde contracten die deze pagina demonstreert.