Koda/OpenUniFi
2
1
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

fixing wiki generation (#38)
Build and publish release / metadata (push) Canceled after 0s
Details
Build and publish release / create-release (push) Canceled after 0s
Details
Build and publish release / build (push) Canceled after 0s
Details
Build and publish release / publish-release (push) Canceled after 0s
Details
Generate and publish developer Wiki / generated-wiki (push) Failing after 43s
Details

Browse Source 
Reviewed-on: #38
Co-authored-by: Koda YeenBean <n122330@gmail.com>
This commit was merged in pull request #38.
This commit is contained in:
Koda
2026-07-19 22:34:26 +01:00
committed by Koda
parent 8bf3e03de8
commit 4f30a031bb
13 changed files with 105 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -9
View File
@@ -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