devops-lib-gcp/docs/index.md

Documentation Index

Catalogue of every doc reachable from this repo. CLAUDE.md's ## Required reading lists the must-reads; everything else lives here. Auto-generated by /meesho-init Phase 10 — edits to the body are reset on next run. To add a doc, drop the file into docs/ and re-run /meesho-init.

Authoritative

Doc	What it covers
docs/architecture.md	System design, module boundaries, deployArgoCD 4-step ceremony, downstream services, critical invariants
docs/wiki/index.md	Synthesized concept pages — owned by /m-wiki
docs/adr/README.md	Architecture Decision Records (16 ADRs, retroactively captured) — owned by /m-docs:adr-generator

Reference

Doc	What it covers
docs/acronyms.md	Domain-specific acronyms used in this repo's code and docs (BU, BUILDKIT, CAC, GCPP, INFRA, …)
docs/downstreams.md	External APIs and services called by the devops-lib pipeline stages (ArgoCD, Ringmaster, JFrog, SonarQube, Vault, Slack, Deployment Tracker)
docs/golden-prs.md	Curated benchmark PRs for evaluating LLM coding agents on this service
docs/infrastructure.md	Storage and registry infrastructure used by the devops-lib pipeline per environment (GAR, ECR, S3, GCS)
docs/review-learnings.md	PR-review-derived skill proposals — auto-generated by /m-docs:pr-learnings (different from review-learnings.md at repo root, which is the manual learnings log)
docs/SECURITY.md	Security policy and contact — auto-generated by /m-docs:security-init
docs/tribal-knowledge.md	Non-obvious conventions, design decisions, operational patterns (15 numbered sections — load-bearing reads for anyone touching the pipeline)

Skills proposals

Doc	What it covers
docs/skills/README.md	Index of proposed Claude Code skills for devops-lib
docs/skills/pipeline-tracer/	Trace a service's complete execution path through devops-lib
docs/skills/library-impact-analyzer/	Identify build-tool / stage / consumer blast radius for a devops-lib PR
docs/skills/build-failure-debugger/	Map a Jenkins job log to the exact devops-lib code path that produced the failure

Other (outside docs/)

Doc	What it covers
README.md	Service blurb + config.yaml schema + adding-a-build-stage walkthrough
CLAUDE.md	Claude-facing repo guide — must-read for agents working here
review-learnings.md	Manual PR-review learnings log (root-level — note: distinct from docs/review-learnings.md, which is the auto-generated skill proposals)
BUGS_AND_IMPROVEMENTS_REPORT.md	Known bug + tech-debt catalogue — read before "fixing" anything that looks suspect