Tyche Wealth Documentation¶
Autogenerated documentation grounded in the current repository state.
This hub is generated from the codebase and supporting documentation workflow. It is meant to expose what is implemented today: service boundaries, persistence structure, runtime behavior, API contracts, and the execution reports that explain how each documentation run was produced.
Snapshot¶
Quick Start¶
Start with repository context, then move into service overviews.
Review API contractsOpen the service API pages available in this repository.
Trace entities and schemaCross-check database relationships against service-level data models.
Inspect generated reportsFollow automation history and branch-level execution summaries.
Core Pages¶
Stable repository context for agents and future documentation runs.
Architecture System ArchitectureRepository-level layering, interactions, and service boundaries.
Operations Observability ArchitectureShared Prometheus and Grafana flow, metric families, and repository config layout.
Persistence Database OverviewConsolidated schema view across implemented services.
Service Pages¶
- No implemented services detected.
Reports¶
Entry point for generated execution reports across the repository.
Feature Branches Feature HistoryGrouped reports by feature branch folder and latest generated alias.
Fix Branches Fix HistoryReserved for bugfix and hotfix report histories when present.
Example Layout¶
reports/feature/TYCHE-10-implement-ci-pipeline/latest-generate_docs.md
reports/feature/TYCHE-10-implement-ci-pipeline/2026-03-12-001920-generate_docs.md
reports/fix/TYCHE-42-correct-rate-limit/latest-review_diagrams.md
Navigation Notes¶
- Prefer these consolidated pages over recreating many small pages for the same area.
- Treat
project-context.mdas stable context and the service pages as the evolving implementation view. - Use reports to understand what each script changed before deciding whether to keep or roll back a run.