gitadmin/devops-lib-gcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added files

Browse Source
This commit is contained in:
Your Name
2026-08-26 02:02:24 +05:30
parent 58ee8a276a
commit 3419cfba0c
200 changed files with 22132 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.md
+43
View File
@@ -0,0 +1,43 @@
# 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](architecture.md) | System design, module boundaries, deployArgoCD 4-step ceremony, downstream services, critical invariants |
| [docs/wiki/index.md](wiki/index.md) | Synthesized concept pages — owned by `/m-wiki` |
| [docs/adr/README.md](adr/README.md) | Architecture Decision Records (16 ADRs, retroactively captured) — owned by `/m-docs:adr-generator` |
## Reference
| Doc | What it covers |
| --- | --- |
| [docs/acronyms.md](acronyms.md) | Domain-specific acronyms used in this repo's code and docs (BU, BUILDKIT, CAC, GCPP, INFRA, …) |
| [docs/downstreams.md](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](golden-prs.md) | Curated benchmark PRs for evaluating LLM coding agents on this service |
| [docs/infrastructure.md](infrastructure.md) | Storage and registry infrastructure used by the devops-lib pipeline per environment (GAR, ECR, S3, GCS) |
| [docs/review-learnings.md](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.md) | Security policy and contact — auto-generated by `/m-docs:security-init` |
| [docs/tribal-knowledge.md](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](skills/README.md) | Index of proposed Claude Code skills for devops-lib |
| [docs/skills/pipeline-tracer/](skills/pipeline-tracer/) | Trace a service's complete execution path through devops-lib |
| [docs/skills/library-impact-analyzer/](skills/library-impact-analyzer/) | Identify build-tool / stage / consumer blast radius for a devops-lib PR |
| [docs/skills/build-failure-debugger/](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](../README.md) | Service blurb + `config.yaml` schema + adding-a-build-stage walkthrough |
| [CLAUDE.md](../CLAUDE.md) | Claude-facing repo guide — must-read for agents working here |
| [review-learnings.md](../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](../BUGS_AND_IMPROVEMENTS_REPORT.md) | Known bug + tech-debt catalogue — read before "fixing" anything that looks suspect |
<!-- meesho-init: plugin-version=1.0.33-with-phase10-backport generated-at=2026-05-22T20:00:00Z base-sha=e504a2b428e4 -->