Skip to content

docs(repo): BEE-1798 reorganize docs tree + add environments snapshot#7

Merged
alfredrc merged 1 commit into
developfrom
docs/bee-1798-reorganize-docs
May 1, 2026
Merged

docs(repo): BEE-1798 reorganize docs tree + add environments snapshot#7
alfredrc merged 1 commit into
developfrom
docs/bee-1798-reorganize-docs

Conversation

@alfredrc
Copy link
Copy Markdown
Member

@alfredrc alfredrc commented May 1, 2026

Summary

  • Group docs by intent: api/ (what server exposes), ops/ (how it's operated), observability/ (runtime). New docs/README.md as index.
  • Capture current dev↔prod state in docs/ops/environments.md — Cloud Run revisions, service accounts, secrets, CORS config, plus 5 riesgos detectados (prod sin Terraform, sin SA dedicado, sin secrets de beepbox, etc.).
  • Fix missing .env/.env.local/.env.*.local entries in .gitignore — these were not gitignored at all.

Tree

docs/
├── README.md                   ← new
├── IDEAS.md                    ← stays at root (global convention)
├── PENDING.md                  ← stays at root (global convention)
├── api/
│   ├── reference.md            (was api.md)
│   └── openapi.yaml
├── ops/
│   ├── infrastructure.md
│   ├── environments.md         ← new snapshot
│   ├── deploy-runbook.md
│   └── supply-chain.md
└── observability/
    ├── metrics.md
    └── tracing.md              (was observability.md)

References updated

  • docs/api/reference.md → fixed docs/openapi.yaml path
  • docs/PENDING.md → fixed 2× docs/deploy-runbook.md paths
  • scripts/validate-openapi.sh → SPEC path
  • .github/workflows/openapi-clients.yml → 3× docs/openapi.yaml paths
  • git mv used everywhere → history preserved

Test plan

  • bash scripts/validate-openapi.shOpenAPI spec is valid (path resolution OK after move)
  • grep -rn final → cero referencias rotas a paths antiguos
  • CI green on this PR (specifically the OpenAPI workflow which now points to docs/api/openapi.yaml)

Closes BEE-1798

🤖 Generated with Claude Code

Group docs by intent: api/ (what the server exposes), ops/ (how it's
operated), observability/ (what's visible at runtime). Add docs/README.md
as index. Capture current dev↔prod state in docs/ops/environments.md
(Cloud Run revisions, service accounts, secrets, CORS, riesgos).

Also add .env, .env.local, .env.*.local to .gitignore — these were
missing entirely from the ignore list.

IDEAS.md and PENDING.md stay at docs/ root per global ecosystem
convention (skills /ideas and /pending look for them there).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@alfredrc alfredrc merged commit eb39fce into develop May 1, 2026
3 checks passed
@alfredrc alfredrc deleted the docs/bee-1798-reorganize-docs branch May 1, 2026 21:57
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