emil
5b05db4e6d
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
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
# GRM — Gitea Runner Manager
|
|
|
|
A lean command-line tool to automate the installation, configuration, and lifecycle management of Gitea Actions runners on Arch Linux, Ubuntu, and Debian hosts.
|
|
|
|
> **Pronunciation:** GRM is short for *Gitea Runner Manager*, but say it like **ГРЪМ** (roughly "GRUM") — the Bulgarian word for **thunder**. An open-source project from **Oblachno** (облачно means *cloudy* in Bulgarian).
|
|
|
|
## User Documentation
|
|
|
|
- [Getting Started](Getting-Started) — Installation, quick start, first run
|
|
- [Installation](Installation) — Prerequisites, setup, multiple instances
|
|
- [CLI Commands](CLI-Commands) — All commands with arguments and options
|
|
- [Troubleshooting](Troubleshooting) — Common issues and solutions
|
|
- [FAQ](FAQ) — Frequently asked questions
|
|
|
|
## Technical Documentation
|
|
|
|
- [Architecture](Architecture) — High-level design, component interactions, data flow
|
|
- [Development Setup](Development-Setup) — Environment setup, dependencies, local testing
|
|
- [CI/CD Workflow](CI-CD-Workflow) — How CI works, release process, branch protection
|
|
- [Testing Strategy](Testing-Strategy) — Unit, integration, and Molecule tests
|
|
- [Decision Log](Decision-Log) — Key technical decisions and rationale
|
|
- [Contributing Guide](Contributing-Guide) — Coding standards, PR workflow, commit rules
|
|
|
|
## Quick Links
|
|
|
|
- [Repository](https://git.oblachno.oblachno.fyi/oblachno-oss/grm)
|
|
- [CI/CD Pipeline](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/actions)
|
|
- [Changelog](https://git.oblachno.oblachno.fyi/oblachno-oss/grm/src/branch/master/CHANGELOG.md)
|