Guides that quietly go stale
A written guide with no link to the code describes last quarter’s screen for months, and people stop trusting it. Keeping pages in the repository means the screen and its guide move together.
Het fundament eronderUI and contentdocumentation
De gidsen
Een geschreven gids voor elk onderdeel van de werkruimte.
De gidsen lopen door Growth-OS zoals jij het gebruikt: aanmelden en wat je rol toestaat, bedrijven en de pipeline, gesprekken en bewijs, doelen en besluiten, campagnes en content, playbooks, de Time Machine, finance, en de werkruimte eromheen. Pagina’s zijn getypeerde content in de repository, dus een gids verandert in dezelfde pull request als het scherm dat hij beschrijft.
- 26 guides, each placed exactly once
- 9 grouped sections in the sidebar
- 0 content services to run
20 van 22 in Het fundament eronder
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 and no file-system conventions to learn.
- 2
Place it in the menu once
Each slug appears exactly once in the category list, and that single placement sets its group and its reading order.
- 3
Everything else derives
The index, sidebar, search corpus, page metadata and next and previous links are computed from that list at build time.
- 4
Tests guard the structure
A page missing from the menu, or listed twice, fails the build. Structure and content cannot fall out of step.
Interactief voorbeeld
Bekijk het in werking
Deze rondleiding toont het geïmplementeerde backendcontract zonder account, credentials of providercalls.
Interactief voorbeeld
Explore the decisions this makes
Signing in and what a role allows
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 content system for a couple of dozen pages
Credentials, webhooks and an editorial pipeline before the first page is live. There is nothing to host here: the guides compile with the app.
A sidebar nobody trusts
When each page lists its own neighbors, someone adds a page, forgets the links, and the sidebar and the next button disagree. One list drives all of it, and a test fails when it is wrong.
Kernpunten
Waarom dit belangrijk is
One list runs everything
Pages and their order live in one typed file. The index, sidebar, search corpus and next links are all derived from it.
Reader comforts included
Search on Cmd or Ctrl and K, a table of contents, reading progress, mobile navigation and feedback all work rather than being planned.
The menu cannot lie
A test fails the build if a page is missing from navigation or listed twice, so the structure cannot quietly drift from the content.
Technische garanties
Wat dit wel en niet belooft
Veiligheidsgrens
Deze pagina’s beschrijven wat de werkruimte doet en verwijzen door; de technische regels blijven in de docs-map van de repository. De site wordt met de app meegecompileerd, niet geserveerd door een gehost contentsysteem, en de Sanity-opzet blijft uitgeschakeld.
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
Hiernaast gebruikt
Deze functies delen contracten en grenzen met deze pagina.
Waar De gidsen op rust
De documentatie beschrijft dezelfde contracten die deze pagina demonstreert.