fixing wiki generation
Generate and publish developer Wiki / generated-wiki (pull_request) Successful in 14s
Generate and publish developer Wiki / generated-wiki (pull_request) Successful in 14s
This commit is contained in:
@@ -48,25 +48,32 @@ architecture map, invariants, and validation checklist.
|
||||
|
||||
## Developer documentation and Gitea Wiki
|
||||
|
||||
The publish-ready Gitea Wiki pages live in [`wiki/`](wiki/). They include a
|
||||
developer guide, a generated Mermaid function-call graph, and runtime flow
|
||||
charts. Refresh them after source or architecture changes:
|
||||
The publish-ready pages live in the separate `Koda/openunifi.wiki` repository.
|
||||
They include a developer guide, a generated Mermaid function-call graph, and
|
||||
runtime flow charts. Check out that repository, then refresh it after source or
|
||||
architecture changes:
|
||||
|
||||
```shell
|
||||
./scripts/docs/generate-wiki.py
|
||||
./scripts/docs/generate-wiki.py --output /path/to/openunifi.wiki
|
||||
```
|
||||
|
||||
Use the same tool as a linter to reject stale pages, oversized C modules,
|
||||
missing documented entry points, or known non-English comment fragments:
|
||||
|
||||
```shell
|
||||
./scripts/docs/generate-wiki.py --check
|
||||
./scripts/docs/generate-wiki.py --check --output /path/to/openunifi.wiki
|
||||
```
|
||||
|
||||
Because Gitea stores Wiki pages in a separate Git repository, publishing is an
|
||||
explicit authenticated step: `./scripts/docs/publish-wiki.sh`. The script
|
||||
derives the `.wiki.git` URL from `origin` and accepts an explicit URL override.
|
||||
No credentials are stored in this repository.
|
||||
The generator uses only the Python 3 standard library, and the publisher uses
|
||||
POSIX shell utilities and Git. Neither downloads or executes an x86-only helper,
|
||||
so both run natively on ARM and x86 build agents.
|
||||
|
||||
Publishing is an explicit authenticated step: `./scripts/docs/publish-wiki.sh`.
|
||||
The script derives the lowercase `.wiki.git` repository URL from `origin`,
|
||||
checks it out before generating, and accepts an explicit URL override. No
|
||||
credentials are stored in this repository. The documentation workflow performs
|
||||
the same two-checkout process and requires `GITEA_TOKEN` to have write access to
|
||||
`Koda/openunifi.wiki`.
|
||||
|
||||
## Automated releases
|
||||
|
||||
|
||||
Reference in New Issue
Block a user