Skip to content

Content Mapping Registry

Map code locations to documentation locations.

Code to Documentation

Code Location Documentation Coupling Notes
scripts/ dev/scripts/ Strong Script behavior and usage
services/api/ services/api.md Strong API behavior and setup
services/web/ services/web.md Strong Web behavior and setup
infra/bootstrap/ platform/terraform/backend-bootstrap/ Strong Backend and state setup
infra/identity/ platform/terraform/github-oidc-identity/ Strong OIDC provider and role
infra/environments/ platform/terraform/eks-environments/ Strong EKS cluster and VPC config
infra/modules/eks/ platform/terraform/eks-environments/ Strong EKS wrapper module
infra/modules/vpc/ platform/terraform/eks-environments/ Strong VPC wrapper module
gitops/clusters/ platform/gitops/ Strong FluxCD bootstrap manifests
gitops/apps/ platform/gitops/app-manifests/ Weak Application manifests structure and customization
.github/workflows/ platform/ci-cd/ Strong Pipeline behavior
local/kubernetes/ platform/local-kubernetes.md Weak Local cluster overview
gitops/apps/ platform/local-kubernetes.md Weak GitOps manifests overview
mise.toml dev/mise/ Strong Tool and task config
.pre-commit-config.yaml dev/pre-commit-hooks/ Strong Hook behavior
docker-compose.yml platform/docker-compose.md Weak Local orchestration
zensical.toml dev/authoring-documentation.md Weak Docs tooling config

Documentation to Code

Documentation Code to Review
dev/scripts/ scripts/
services/api.md services/api/
services/web.md services/web/
platform/terraform/backend-bootstrap/ infra/bootstrap/
platform/terraform/github-oidc-identity/ infra/identity/
platform/terraform/eks-environments/ infra/environments/, infra/modules/eks/, infra/modules/vpc/
platform/gitops/ gitops/clusters/
platform/gitops/app-manifests/ gitops/apps/
platform/ci-cd/ .github/workflows/
platform/local-kubernetes.md local/kubernetes/, gitops/apps/

Coupling

  • Strong: code changes require immediate doc updates.
  • Weak: update docs when behavior changes materially.

See Also