Documentation Systems
This portal explains the delivered SaaS foundation and how to turn it into a customer-owned product, while the accompanying technical guide provides deeper implementation and operations detail.
On this page
Two documentation systems
| System | Audience | Builder reference | Publishing model |
|---|---|---|---|
| Customer help center | People who use your finished product. | Implementation referencesrc/features/docs/shared/content.ts and src/features/docs/ui. | Ships at /docs inside your application; replace the starter content with workflows and support information for your own users. |
| Builder and maintainer guide | People who customize, deploy, and operate the delivered product. | The accompanying docs directory plus README, AGENTS.md, SECURITY.md, SUPPORT.md, and LICENSE. | Use it when building or operating the product; implementation references in this portal remain optional and collapsed where possible. |
Implementation reference3 areas
These Product code locations explain how the documented behavior is implemented. Expand them when you are ready to customize or maintain this area.
Content contract
Stable section identifiers and typed blocks define the replaceable starter content.
src/features/docs/shared/content.tssrc/features/docs/shared/types.ts
Explorer UI
Navigation, filtering, rendering, and block presentation form the in-product documentation experience.
src/features/docs/ui/explorer.tsxsrc/features/docs/ui/navigation.tsxsrc/features/docs/ui/blocks.tsx
Route entrypoint
The public /docs route delegates rendering to the feature UI.
src/app/docs/page.tsxsrc/features/docs/ui/page.tsx
Reference paths are relative to the delivered product checkout.
Maintainer guide map
| File | Use |
|---|---|
| docs/getting-started/launch.md | Production launch checklist. |
| docs/deploy/deployment.md | Deployment guide and host capability notes. |
| docs/extend/customization.md | Branding, UI, and copy customization guide. |
| docs/extend/development.md | Feature development workflow rules. |
| docs/extend/architecture.md | Platform architecture boundary guidelines. |
| docs/extend/module-removal.md | Safe module removal checklist. |
| docs/extend/testing.md | Testing guidelines and layers. |
| docs/operate/operations.md | Production operations, incident response, recovery, retention, and scheduled jobs. |
| docs/getting-started/buyer-quickstart.md | Shortest path from a delivered checkout to a running product. |
| docs/product/billing/setup.md | Provider-edition billing setup and links to Stripe, Lemon Squeezy, Dodo Payments, Polar, and Creem guides. |
| docs/product/notifications/email/setup.md | Supabase Auth and Resend transactional email configuration. |
Update documentation in the same change when you
- Add, rename, or remove an environment variable, route, role, table, RPC, storage bucket, job, webhook, event, or command.
- Change a provider setup step, capability, payload, dashboard setting, or test-mode procedure.
- Change a customer workflow, module boundary, failure mode, support process, or removal path.
- Add a migration, backfill, repair, retention rule, backup requirement, or recovery step that operators must understand.
- Change the product behavior represented in your published customer help center.