Application documentation
Use this handbook to run, change, and operate the application in this checkout. Read the application profile for purpose and ownership. Contributors follow the project conventions and documentation rules.
Start here
| Task | Guide |
|---|---|
| Run locally | Set up the environment, then start and check readiness |
| Implement a feature | Follow the implementation workflow |
| Test a change | Choose checks and prepare dependencies |
| Diagnose a failure | Follow symptoms and recovery checks |
| Investigate missing events | Inspect outbox delivery |
Documentation index
The complete index follows the published sidebar's reading order.
Handbook
| Document | Purpose |
|---|---|
| Writing documentation | Writing rules, document templates, checks, and publishing |
| Project conventions | Application-specific rules and a reference to shared Go conventions |
| Application profile | Purpose, ownership, current capabilities, and documentation gaps |
| Configuration | Configuration sources, backend choices, defaults, and deployment settings |
| Development workflow | Setup, implementation, generation, tooling, and contributions |
| Testing and verification | Suite selection, test environments, coverage, and checks before review |
| Architecture | Source map, component boundaries, request and event flows, and lifecycle |
| Using the API | Credentials, session flow, local verification, and request failure diagnosis |
| Release | Version selection, release validation, published artifacts, and image identity |
| Deployment | Container and Helm configuration, migration handoff, and rollout verification |
| Operations | Probe checks, process lifecycle, outbox diagnosis, and failure recovery |
| Monitoring | Collect metrics, interpret signals, and configure the supplied dashboard |
| GitHub configuration | Required and optional workflow variables and secrets |
Requirements
No application requirements are recorded yet. Start with the requirement template.
Decisions
No application decisions are recorded yet. Start with the decision template.
Templates
Start new documents from a template and follow the steps for creating a document.
| Template | Purpose |
|---|---|
| Handbook | Current behavior, architecture, and working instructions |
| Requirement | Desired outcomes, scope, acceptance criteria, and verification |
| Decision | Significant choices, alternatives, reasoning, and consequences |
References
API contracts live with their source definitions. The published site also provides an OpenAPI view.
For the blueprint and its default workflows, see the go42 guide.
See where docs belong when deciding which project to update.
Source: docs/README.md. Revision: 3841815ceb9e.