Source file

docs/README.md

BrightWeb Platform Docs

This docs/ folder is the single source of truth for BrightWeb documentation.

  • Humans should be able to read it directly in the repo.
  • The dev-docs app renders the same files online.
  • Agents should read and update docs here, not in apps/dev-docs/app/docs.

Fast map

Sections

Recommended read order

  1. Foundations
  2. Modules
  3. Architecture reference
  4. Operations reference
  5. Recipes

How this repo should use docs

  1. Put durable product, architecture, and operations knowledge in docs/.
  2. Keep app-only documentation logic out of apps/dev-docs when possible.
  3. Treat the docs app as a presentation layer over this folder, not a separate content system.

Repo source

  • docs/README.md
  • This page is rendered directly from the root docs folder. Edit the markdown there, not inside the app.