oblachno-oss/grm
3
0
Fork 0
Code Issues 25 Pull Requests 2 Actions Packages Projects Releases 16 Wiki Activity

GRM-36: Implement documentation-as-code with wiki sync and doc-coverage #26

Merged
emil merged 0 commits from GRM-36-documentation-as-code into master 2026-06-21 19:45:35 +00:00
Conversation 0 Commits - Files Changed -
emil commented 2026-06-21 19:43:18 +00:00
Owner
Copy Link
Copy Source

Summary

Implements a full documentation-as-code workflow: all documentation lives in /docs/ in the repository and is automatically synced to the Gitea wiki on every merge to master.

Changes

Documentation Structure

  • /docs/user/ — Getting Started, Installation, CLI Commands, Troubleshooting, FAQ
  • /docs/tech/ — Architecture, Development Setup, CI/CD Workflow, Testing Strategy, Decision Log, Contributing Guide
  • /docs/index.md — Wiki homepage with links to all pages
  • /docs/mapping.json — File-to-wiki-page title mapping
  • README.md slimmed down to a lean entry point with wiki links

Wiki Sync

  • scripts/sync_wiki.py — Syncs docs to Gitea wiki via API (create/update pages)
  • .gitea/workflows/sync-wiki.yml — Runs sync on merge to master and on release tags

Documentation Coverage

  • scripts/doc_coverage.py — Checks that all CLI commands (9), Python modules (8), and CI scripts (6) are documented
  • Added as a CI step in the quality job
  • Currently at 100% coverage

Tests

  • 28 new unit tests for sync_wiki.py and doc_coverage.py
  • 100% coverage maintained (452 total tests)

Closes GRM-36

## Summary Implements a full documentation-as-code workflow: all documentation lives in /docs/ in the repository and is automatically synced to the Gitea wiki on every merge to master. ## Changes ### Documentation Structure - /docs/user/ — Getting Started, Installation, CLI Commands, Troubleshooting, FAQ - /docs/tech/ — Architecture, Development Setup, CI/CD Workflow, Testing Strategy, Decision Log, Contributing Guide - /docs/index.md — Wiki homepage with links to all pages - /docs/mapping.json — File-to-wiki-page title mapping - README.md slimmed down to a lean entry point with wiki links ### Wiki Sync - scripts/sync_wiki.py — Syncs docs to Gitea wiki via API (create/update pages) - .gitea/workflows/sync-wiki.yml — Runs sync on merge to master and on release tags ### Documentation Coverage - scripts/doc_coverage.py — Checks that all CLI commands (9), Python modules (8), and CI scripts (6) are documented - Added as a CI step in the quality job - Currently at 100% coverage ### Tests - 28 new unit tests for sync_wiki.py and doc_coverage.py - 100% coverage maintained (452 total tests) Closes GRM-36
emil merged commit bf84cb2bcb into master 2026-06-21 19:45:35 +00:00
emil deleted branch GRM-36-documentation-as-code 2026-06-21 19:45:35 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is not working
 ci-improvement
CI workflow improvements
 doc-improvement
Documentation improvements
 feedback
Issues from subagent or agent feedback
 ready-to-merge
Auto-merge PR when all CI checks pass
 tooling
Tool-related feedback or improvements
 workflow-improvement
Workflow alignment or pattern improvements
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
emil (emil User) emo kireto
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: oblachno-oss/grm#26