GRM-36: feat: implement documentation-as-code with wiki sync and doc-coverage

Add /docs/ directory with user and technical documentation extracted from README, AGENTS.md, and source code. Add scripts/sync_wiki.py to sync docs to Gitea wiki via API. Add scripts/doc_coverage.py to check CLI commands, modules, and CI scripts are documented. Add sync-wiki.yml workflow for auto-sync on merge and release. Slim down README.md to lean entry point. 28 new unit tests, 100% coverage maintained. Closes GRM-36
2026-06-21 19:45:34 +00:00
parent 7fe85423b4
commit 5b05db4e6d
21 changed files with 1899 additions and 415 deletions
@@ -204,3 +204,48 @@ Platform list is defined in `scripts/distribute_molecule.py` (single source of t

 - `ansible-lint` may warn about `command-instead-of-module` for `systemctl --user` calls — this is expected (systemd module doesn't support user services) and skipped in `.ansible-lint`
 - Molecule Docker driver may print "Event loop is closed" warnings on interrupt — harmless
+
+## Documentation-as-Code
+
+All documentation lives in `/docs/` and is synced to the Gitea wiki automatically.
+
+### Structure
+
+```
+docs/
+├── index.md              # Wiki homepage
+├── mapping.json          # File-to-wiki-page title mapping
+├── user/                 # User documentation
+│   ├── getting-started.md
+│   ├── installation.md
+│   ├── cli-commands.md
+│   ├── troubleshooting.md
+│   └── faq.md
+└── tech/                 # Technical documentation
+    ├── architecture.md
+    ├── development-setup.md
+    ├── ci-cd-workflow.md
+    ├── testing-strategy.md
+    ├── decision-log.md
+    └── contributing.md
+```
+
+### Wiki Sync
+
+- **On merge to master**: `sync-wiki.yml` workflow runs `scripts/sync_wiki.py` which pushes all `/docs/` content to the Gitea wiki via API
+- **On release tag**: Same sync runs, plus the wiki is tagged with the release version
+- `mapping.json` maps each file path to a wiki page title (e.g., `user/getting-started.md` → `Getting-Started`)
+- README.md is a lean entry point with links to the wiki — no detailed content
+
+### Documentation Coverage
+
+- `scripts/doc_coverage.py` checks that all CLI commands, Python modules, and CI scripts are documented
+- Runs as a CI step in the quality job
+- Goal: 100% coverage for public CLI commands and major architectural components
+
+### Updating Documentation
+
+1. Edit files in `/docs/`
+2. If adding a new page, add it to `docs/mapping.json`
+3. Commit and create a PR (standard PR workflow)
+4. On merge, wiki is automatically synced