Welcome to the central documentation hub for our organization's engineering ecosystem. This repository serves as the single source of truth for high-level technical decisions, user guides, and performance metrics across all our services.
In a microservices architecture, documentation easily becomes fragmented. This repository centralizes all cross-cutting technical information that does not belong to a single service repo, ensuring alignment across engineering, product, and operations teams.
The content is organized into specific directories based on the type of documentation:
/adrs: Architecture Decision Records (ADRs) tracking historical and current technical design choices./user-manuals: User guides, system operation manuals, and API consumption instructions./performance-testing: Quality assurance benchmarks, featuring automated and manual K6 load test reports.
We encourage all team members to keep this documentation alive and accurate.
- Create a branch: Use
feature/doc-[topic]orfix/doc-[topic]. - Follow templates: Use the standardized markdown templates found inside each directory (e.g., ADR template).
- Submit a PR: Open a Pull Request for peer review before merging into
main.
For specific service code, deployment pipelines, or local setup guides, please refer to the respective service repositories in our GitHub organization.