docs: add automated compose documentation generation pipeline
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
# Generated Documentation
|
||||
|
||||
## Local generation
|
||||
|
||||
```bash
|
||||
chmod +x scripts/docs/*.sh
|
||||
scripts/docs/generate-all.sh
|
||||
```
|
||||
|
||||
This pipeline only runs `docker compose config` and static parsing. It does **not** start containers.
|
||||
|
||||
## CI behaviour
|
||||
|
||||
GitHub Actions workflow `.github/workflows/generate-docs.yml` runs on pushes/PRs to `main` and manual dispatch. It generates docs and uploads them as the `generated-documentation` artifact.
|
||||
|
||||
## Outputs
|
||||
|
||||
- `docs/generated`: resolved compose config and markdown inventories
|
||||
- `docs/diagrams`: DOT and SVG architecture diagram
|
||||
- `docs/public`: sanitized copy for public sharing
|
||||
|
||||
## Publication safety
|
||||
|
||||
- `docs/public` is intended for public sharing after sanitization.
|
||||
- `docs/generated` and `docs/diagrams` may include internal details and should be treated as internal by default.
|
||||
Reference in New Issue
Block a user