docs: update generated developer wiki

openUF documentation bot
2026-07-19 21:49:40 +00:00
parent f241b021a2
commit 0eee2b0988
2 changed files with 17 additions and 13 deletions
+13 -10
@@ -138,18 +138,22 @@ development packages installed. It is not a host-side test substitute.
## Documentation workflow ## Documentation workflow
Generate pages after changing C code or architecture: Check out the separate `openunifi.wiki` repository, then generate pages after
changing C code or architecture:
```sh ```sh
./scripts/docs/generate-wiki.py ./scripts/docs/generate-wiki.py --output /path/to/openunifi.wiki
``` ```
Run the linter-style drift and structure check in CI or before committing: Run the linter-style drift and structure check in CI or before committing:
```sh ```sh
./scripts/docs/generate-wiki.py --check ./scripts/docs/generate-wiki.py --check --output /path/to/openunifi.wiki
``` ```
The generator uses only the Python 3 standard library. The publisher uses POSIX
shell utilities and Git, so neither path depends on the runner CPU architecture.
The checker parses C functions recursively, rebuilds internal call edges, The checker parses C functions recursively, rebuilds internal call edges,
validates required runtime entry points, rejects known non-English comment validates required runtime entry points, rejects known non-English comment
fragments, and limits each implementation unit to fragments, and limits each implementation unit to
@@ -157,10 +161,9 @@ fragments, and limits each implementation unit to
## Publishing to the Gitea Wiki ## Publishing to the Gitea Wiki
Gitea stores a repository Wiki in a separate Git repository whose URL normally Gitea stores this documentation in the separate lowercase
ends in `.wiki.git`. The generated `wiki/` directory is ready for that remote. `openunifi.wiki` repository. Run `scripts/docs/publish-wiki.sh` from a trusted
Run `scripts/docs/publish-wiki.sh` from a trusted machine with suitable machine with suitable credentials. It derives that repository from `origin`;
credentials. It derives the Wiki remote from `origin`; an explicit URL may be an explicit URL may be passed when needed. The publisher checks out the Wiki
passed when needed. The publisher regenerates and checks the pages, repository before generating, updates only the generated Markdown files,
updates only the generated Markdown files, commits changed pages, and pushes commits changed pages, and pushes them back to the Wiki repository.
them to the Wiki repository.
+4 -3
@@ -1,7 +1,7 @@
# openUF Developer Wiki # openUF Developer Wiki
This Wiki is generated from the current source tree and maintained in the main This Wiki is generated from the current source tree and maintained in the
repository so architecture documentation changes can be reviewed with code. separate `openunifi.wiki` repository.
- [[Developer Guide|Developer-Guide]] — architecture, invariants, extension - [[Developer Guide|Developer-Guide]] — architecture, invariants, extension
points, build validation, and Wiki publishing. points, build validation, and Wiki publishing.
@@ -10,4 +10,5 @@ repository so architecture documentation changes can be reviewed with code.
- [[Function Call Graph|Call-Graph]] — generated internal caller/callee graph - [[Function Call Graph|Call-Graph]] — generated internal caller/callee graph
and searchable function table. and searchable function table.
Run `./scripts/docs/generate-wiki.py --check` to verify these pages are current. Run `./scripts/docs/generate-wiki.py --check --output /path/to/openunifi.wiki`
from the source checkout to verify these pages are current.