12-Factor Reviewer Documentation¶
Audience: All users, developers, and contributors
WHAT¶
12-Factor Reviewer is a language-agnostic CLI tool for assessing 12-Factor App compliance. This hub provides navigation to all project documentation.
WHY¶
Centralized documentation access prevents fragmentation and ensures all audiences — users, developers, and architects — can find what they need.
HOW¶
Quick Navigation¶
| I want to... | Go to |
|---|---|
| Get started quickly | Quick Start |
| Understand the architecture | Architecture |
| Contribute to the project | Contributing |
| Integrate with CI/CD | CI/CD Integration |
| Look up common questions | FAQ |
By SDLC Phase¶
| Phase | Contents |
|---|---|
| 3-design | Architecture, API Reference, Tech Stack |
| 4-development | Installation, Usage, Contributing, CI/CD Integration |
| 5-testing | Testing |
Reference Documentation¶
| Document | Description |
|---|---|
| Quick Start | Commands cheat sheet and getting started |
| API Reference | CLI options, functions, and integration examples |
| Tech Stack | Technologies, detection capabilities, and requirements |
| FAQ | Frequently asked questions and troubleshooting |