跳到主要内容

2026-04-23-rgb-docs-site-implementation

Status​

Implemented

Date​

2026-04-23

Owners​

  • Platform Backend
  • Developer Experience
  • docs/specs/documentation/2026-04-23-rgb-docs-site-integration.md

Goal​

Implement the first internal docs portal for RGB by integrating Docusaurus directly against the current docs/ source tree.

Checklist​

  • Create a standalone site scaffold under docs/docusaurus/.
  • Map all current top-level doc categories as separate mounted sections.
  • Add section landing pages for categories that previously lacked them.
  • Add a custom homepage that explains the stable/change/reference split.
  • Add local usage instructions for maintainers.
  • Enable fail-fast handling for broken links and broken Markdown links.
  • Run local typecheck and build validation for the new site.

Follow-Up​

  • Add docs CI to pull requests.
  • Add docs deployment workflow for Cloudflare Pages.
  • Decide whether to generate OpenAPI docs inside the same site.
  • Add search once the internal hosting target is finalized.
  • Decide whether screenshots and Mermaid diagrams need dedicated style rules.