docs: move public docs generation to local workflow
This commit is contained in:
@@ -120,6 +120,37 @@ flowchart TB
|
||||
|
||||
For request-flow and network detail, see [docs/architecture.md](docs/architecture.md).
|
||||
|
||||
## Public docs publication workflow
|
||||
|
||||
Public docs are generated on the Docker host and committed to this repository. GitHub Actions only publishes committed content from `docs/public`.
|
||||
|
||||
1. Generate public docs locally from the repository root:
|
||||
|
||||
```bash
|
||||
./scripts/generate-public-docs.sh
|
||||
```
|
||||
|
||||
2. Inspect the generated changes:
|
||||
|
||||
```bash
|
||||
git diff -- docs/public docs/generated docs/diagrams
|
||||
```
|
||||
|
||||
3. Commit the generated public docs (and any supporting generated files you intend to version):
|
||||
|
||||
```bash
|
||||
git add docs/public docs/generated docs/diagrams
|
||||
git commit -m "docs: regenerate public docs"
|
||||
```
|
||||
|
||||
4. Push your branch:
|
||||
|
||||
```bash
|
||||
git push
|
||||
```
|
||||
|
||||
Only files under `docs/public` are published by GitHub Pages. Internal/generated documentation is not published unless it is deliberately copied/sanitized into `docs/public`.
|
||||
|
||||
### Regenerating architecture docs (Prometheus + Dynu DNS)
|
||||
|
||||
```bash
|
||||
|
||||
Reference in New Issue
Block a user