This repository is the single source of truth for GradeLoop V2. The detailed, actionable developer and operator documentation lives in the docs/ directory and per-service READMEs. This top-level file is an index pointing you to those resources — it intentionally does not duplicate documentation content.
Use the links below to find what you need.
Quick links
- Local development & setup: docs/guides/local-dev-guide.md
- Documentation index: docs/README.md
- Contribution & PR guidelines: CONTRIBUTING.md
- Service communication patterns (gRPC/REST/events): docs/guides/service-communication.md
- Observability, metrics, logs, and tracing: docs/guides/observability.md
- Architecture Decision Records (ADRs): docs/adr/README.md (individual ADRs under
docs/adr/) - API docs placeholder: docs/api/
- Per-service READMEs:
apps/services/<service-name>/README.md(e.g. apps/services/iam-service/, apps/services/email-notify-service/) - Infrastructure and local compose: infra/compose/compose.dev.yaml
- Dev scripts: scripts/
- Ops & observability configs: ops/
If you're getting started, open docs/README.md first — it contains a curated path for common tasks (setup, running the stack, testing, debugging). For anything not covered, check the service README under apps/services/<service> or open an issue / ask in #gradeloop-dev.
Contributing
- Follow CONTRIBUTING.md for commit messages, branch naming, PR structure, and testing requirements.
- Add ADRs to
docs/adr/for significant architectural changes.
Where to run things
- Local full-stack: See infra/compose/compose.dev.yaml and docs/guides/local-dev-guide.md.
- Run a single service: see that service's README in
apps/services/<service-name>/README.md.
Support
- For help or questions, contact the engineering team (
#gradeloop-dev) or open an issue in the repo. - If you want me to expand any guide or add new documentation pages, tell me which topic and I’ll draft it.
Thank you for contributing to GradeLoop V2.