GitHub Backup Automation System — Documentation Index
This directory serves as the centralized technical documentation hub for developers, operators, and AI agents.
Technical Documentation Sitemap
| Category | Document | Description |
|---|---|---|
| System Architecture | ARCHITECTURE.md | High-level system architecture, service breakdown, database schema, and deployment models. |
| API Specification | API_REFERENCE.md | Comprehensive REST and WebSocket API endpoints, request/response schemas, and error codes. |
| Dashboard Sign-in | AUTH_SETUP.md | GitHub App or OAuth App setup, callback URLs, session cookies, the optional login gate, and the variables on the dashboard and the Observatory. |
| Pre-Commit Workflow | PRECOMMIT_WORKFLOW.md | Automated Git pre-commit validation gate, staged file filtering, and developer commands. |
| Streaming Architecture | STREAMING_ARCHITECTURE.md | SSE and WebSocket telemetry streams, event schemas, and proxy buffering guidelines. |
| Worker Logins | CLI_AUTH_SETUP.md | Backup worker logins: creating the GitHub App, the device flow, destination and OpenRouter logins, where they are stored, troubleshooting. |
| Postman API Suite | POSTMAN_SETUP.md | Postman collection setup guide and testing workflows. |
| Audits | audits/2026-09-24-full-audit.md | The full audit: every finding, the pull request that fixes it, owner actions, what was not verified, follow-ups. |
| Postman Artifacts | postman/ | Exported Postman JSON collection and environment definitions. |
Core Repository Guides
- Root README: System overview, live demo links, and developer getting started guide.
- Branching Policy: Branch-first development workflow, hierarchical naming (
<github-username>/<parent-branch>/<feature>), and lifecycle rules. - Repository Workflow: Complete engineering lifecycle and explicit Human-In-The-Loop Push Boundary.
- Agent Rules: Operational boundaries and verification checklists for AI agents.
- Agent Skills: Specialized runbooks and procedural skills for AI agents.