Skip to content

Docs/documentation - #18

Merged
BehRoooz merged 9 commits into
mainfrom
docs/documentation
Jul 28, 2026
Merged

Docs/documentation#18
BehRoooz merged 9 commits into
mainfrom
docs/documentation

Conversation

@BehRoooz

Copy link
Copy Markdown
Owner

Summary

  • Rewrite README.md as a production front door: product overview, architecture, quickstart, config, training/serving, monitoring, CI/CD, and links into deeper docs
  • Add structured documentation under docs/: architecture, data, training, deployment, monitoring, troubleshooting, and contributing
  • Align docs with the current stack (Compose overlays, NGINX gateway, MLflow/Postgres/MinIO/Redis, monitoring profiles, GHCR CI)

BehRoooz added 9 commits July 28, 2026 15:29
…sequence→GO, async jobs, training), data/artifact flow, Compose topology, security (NGINX tiers), integration points, design decisions
…on, preprocess/split/embed pipeline, sequence normalization, data contracts, retention, reproducibility checklist
…g, registry/champion promotion, retrain options (CLI/API/hybrid), compute requirements, evaluation protocol, known limitations
…X routing, deployment patterns, CI/CD/GHCR, release/rollback, scaling, backups, Make targets
…, alert rules (using actual ProSeqGO* alert names from alerts.yml), SLO guidance, per-alert runbooks, PromQL examples
…e, monitoring, worker crash recovery, escalation path
…e-type checklist, security, dependency policy
…ata → quickstart → config → training → serving → monitoring → CI → deployment → docs map → contributing → troubleshooting → Make targets → license
@BehRoooz
BehRoooz merged commit f4fc27b into main Jul 28, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant