finos / finos/architecture-as-code
calm-hub: document the GitHub storage backend and its config surface
- Dominant language
- TypeScript
- Stars
- 399
- Forks
- 138
- Avg merge
- 2d 14h
- Merged PRs (30d)
- 37
Description
The GitHub storage backend (`calm.database.mode=github`) has no user-facing documentation — no explanation of the namespace-to-repo config surface (`calm.github.namespaces`, access groups, clone directory), the OAuth-adjacent config, or the read-only/SHA-versioning model it exposes.
**Fix:** add a docs page (or ADR under `calm-hub/decisions/`) covering: configuring namespaces and access groups, what read-only mode means for this backend, and how versions work (real SHAs, no semver, no `latest`).
Contributor guide
Research direction
Start with the GitHub backend configuration around calm.database.mode=github and the calm-hub/decisions/ directory to find the appropriate documentation location. Document namespace and access-group settings, clone directory and OAuth-adjacent configuration, read-only behavior, and SHA-based versioning; done means users can configure the backend and understand that it has no semver or latest versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100