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-docsapp renders the same files online. - Agents should read and update docs here, not in
apps/dev-docs/app/docs.
Fast map
- Start at Foundations
- Then read Modules
- Then use Architecture reference and Operations reference as needed
- Treat this file as the docs index for both humans and agents
Sections
Recommended read order
How this repo should use docs
- Put durable product, architecture, and operations knowledge in
docs/. - Keep app-only documentation logic out of
apps/dev-docswhen possible. - Treat the docs app as a presentation layer over this folder, not a separate content system.
Repo source
docs/README.mdThis page is rendered directly from the root docs folder. Edit the markdown there, not inside the app.