beatz174-bit
31 lines
855 B
Markdown
31 lines
855 B
Markdown
# Operations
|
|
|
|
## Local docs generation
|
|
|
|
```bash
|
|
chmod +x scripts/docs/*.sh
|
|
scripts/docs/generate-all.sh
|
|
```
|
|
|
|
## Inspect generated changes
|
|
|
|
```bash
|
|
git status -- docs/generated docs/diagrams docs/public
|
|
```
|
|
|
|
## GitHub Actions artifacts
|
|
|
|
Use the **Generate documentation** workflow run and download the `generated-documentation` artifact from the run summary.
|
|
|
|
## Commit behavior
|
|
|
|
- Pull requests generate docs and upload artifacts only.
|
|
- Pushes to `main` generate docs, upload artifacts, and commit generated docs when changes exist.
|
|
- Manual workflow runs can commit generated docs when enabled through workflow input.
|
|
|
|
## Troubleshooting
|
|
|
|
- Confirm required tooling (`python3`, `jq`, `graphviz`, `docker compose`) is available.
|
|
- Re-run generation after documentation script changes.
|
|
- Review `docs/public` output for redaction coverage before sharing.
|