Docs/improve documentation#126
Conversation
system-architecture.md and its UML diagrams describe a 3-service, 4-role early design that never tracked the system as it grew to 6 Spring services plus GenAI; backlog.md is similarly frozen mid-project. Keeping them in docs/outdated/ preserves the history without presenting them as current.
Previously a monolith that had accumulated deep operational detail (Terraform variable lists, full secrets tables, per-metric breakdowns) alongside the high-level overview a first-time reader actually needs. Keeps every topic represented here at a useful summary depth, and moves the detail that only an implementer needs into dedicated docs/ pages.
Per-service responsibilities, interface contracts (who calls whom, incl. the genai->feedback and org/member->Keycloak-admin-API calls that weren't documented anywhere), and the request/auth lifecycle for architecture; Terraform/Ansible internals and the Azure-vs-Kubernetes environment split for deployment. Both are prose-only by design, replacing the retired UML diagrams rather than re-deriving new ones.
Full CI/CD job breakdown and the complete secrets/variables inventory (including FORWARD_AUTH_COOKIE_SECRET, which wasn't documented anywhere before) for cicd.md; full metrics table, dashboard panel breakdown, and alert rule definitions for monitoring.md.
# Conflicts: # README.md
|
Warning Review limit reached
Next review available in: 37 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (7)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
2 participants
I improved the documentation by splitting up details of the README into detail pages for some sections and updated content to the current version of the app.