Documentation in a place you can't miss
Every domain lib ships a README — ownership, boundaries, and how to run it alone.
nx-monorepo-docs-readme-required
Why it matters
| Stake | If ignored |
|---|---|
| No ownership |
|
How to fix
Every app has a README. Every feature lib has a README. It explains: responsibility, public API, how to run alone, external dependencies.
Examples
text
/apps/sites-management
/src
project.json
(no README)markdown
# Sites Management
## Responsibility
Sites, projects, organizations, users.
## Run standalone
```bash
pnpm nx serve sites-management
# http://localhost:4201
```
## Libraries
- `libs/sites-management/feature-*` — screens.
- `libs/sites-management/data-access` — public API. **Only this is exported to other domains.**
- `libs/sites-management/ui` — internal components.
## External dependencies
- Postgres
- No dependency on other domains. See `nx graph`.
## Owner
Team X.