Reference
Use reference pages when you need exact facts, supported options, and stable technical contracts.
System contracts
CLI commands, navigation schema, route model, automation scripts, and configuration entry points.
Reference pages
Current route model
/ marketing-first root surface
/docs first-party technical product docs (Diataxis)
/tfl demo TfL product docs
/petstore demo Petstore product docs
/platzi demo Platzi Fake Store docs
/tfl/api-playground, /petstore/api-playground, and /platzi/api-playground interactive demo routes
Configuration entry points
- Site config:
docusaurus.config.ts - Sidebars:
sidebarsDevdocify.ts,sidebarsTfl.ts,sidebarsPetstore.ts,sidebarsPlatzi.ts - Navigation contract loader:
navigation-contract.ts - Navigation definitions:
docs/*/navigation.json - SAML config example:
saml.config.example.json - RBAC config example:
rbac.config.example.json - Assistant config example:
assistant.config.example.json - Workflows:
.github/workflows/ci.yml,.github/workflows/preview.yml,.github/workflows/rbac-check.yml,.github/workflows/link-check.yml,.github/workflows/docs-draft-update.yml
Automation scripts
| Script | Purpose |
|---|---|
scripts/build-route-manifest.ts | Builds the route manifest for all docsets. |
scripts/build-search-index.ts | Builds the local docs and API operation search index. |
scripts/push-search-index.ts | Pushes the built search index to Algolia. |
scripts/generate-llms-txt.ts | Generates llms.txt with canonical docs and API route URLs. |
scripts/validate-saml-config.ts | Validates SAML configuration. |
scripts/generate-nginx-auth-config.ts | Generates nginx auth_request configuration from SAML settings. |
scripts/validate-rbac-config.ts | Validates RBAC role assignments. |
scripts/check-rbac-permission.ts | Checks whether an actor has a capability such as content.publish. |
scripts/validate-analytics-event.ts | Validates analytics event payloads and prints the event schema. |
scripts/validate-assistant-quality.ts | Enforces assistant policy and grounding requirements. |
scripts/benchmark-build.ts | Benchmarks full Docusaurus builds at synthetic fixture scale. |