# docs/_meta/pkg-to-page.yaml
#
# Maps every exported Go package (as returned by `go list ./...`) to its
# canonical documentation page.  PACKAGES ONLY — CLI surface coverage for
# cmd/* is enforced separately (one docs/cli/<tool>.md per cmd/<tool>/main.go).
#
# CI enforces: every package in `go list ./...` that is NOT under `internal/`
# and NOT under `cmd/` must appear here. Unmapped packages fail `make docs-coverage-gate`.
#
# Format:
#   <import-path-suffix>: <doc-page-path relative to docs/>
#
# Use "__SKIP__" for packages that intentionally have no doc page (add a comment
# justifying the skip).
#
# This file is HAND-EDITED and PR-reviewed. Run `make docs-coverage-gate` to
# validate. The seed generator (`scripts/docgen/seed-pkg-map.sh`) can emit a
# draft but it is never auto-committed.
#
# Last updated: 2026-03-02
# Run `make docs-gen` then `make docs-coverage-gate` to re-validate after
# adding new packages.
# ---------------------------------------------------------------------------

# ── Edge module (github.com/autonomyops/adk/edge) ────────────────────────

edge/assurance:      resource-envelope/cgroup-v2.md
edge/beacon:         security/beacon-privacy.md
edge/bootstrap:      architecture/edge-layer.md
edge/certrotation:   security/mtls.md
edge/config:         config/reference.md
edge/epoch:          architecture/invariants.md
edge/eviction:       resource-envelope/disk-ceiling.md
edge/fi:             fi-catalog/matrix.md
edge/index:          storage/data-model.md
edge/metrics:        __SKIP__  # Prometheus metrics — no standalone doc page yet; covered inline in resource-envelope pages
edge/quota:          fi-catalog/matrix.md
edge/relay:          architecture/edge-layer.md
edge/retry:          resource-envelope/retries.md
edge/rpcv1:          api/rpc-endpoints.md
edge/scheduler:      architecture/edge-layer.md
edge/segment:        storage/data-model.md
edge/stateroot:      storage/on-disk-layout.md
edge/storage:        storage/data-model.md
edge/transport:      api/transport-messages.md

# ── Lock module (github.com/autonomyops/adk/lock) ──────────────────────────
lock:                __SKIP__  # Lock module docs are not authored yet; tracked in docs workplan backlog

# ── Runtime module (github.com/autonomyops/adk/runtime) ────────────────────
runtime:             __SKIP__  # Runtime module docs are not authored yet; tracked in docs workplan backlog

# ── Policy module (github.com/autonomyops/adk/policy) ──────────────────────
policy:              __SKIP__  # Policy module docs are not authored yet; tracked in docs workplan backlog

# ── OCI module (github.com/autonomyops/adk/oci) ────────────────────────────
oci:                 __SKIP__  # OCI module docs are not authored yet; tracked in docs workplan backlog
oci/sign:            __SKIP__  # OCI signing subpackage docs are not authored yet; covered at high level in security docs

# ── Telemetry module (github.com/autonomyops/adk/telemetry) ────────────────
telemetry:           __SKIP__  # Telemetry module docs are not authored yet; tracked in docs workplan backlog

# ── Orchestrator module (github.com/autonomyops/adk/orchestrator) ─────────
orchestrator:        __SKIP__  # Orchestrator module docs are not authored yet; tracked in docs workplan backlog
orchestrator/pgstore: tutorials/orchestrator-ha-runbook.md

# ── CLI module (github.com/autonomyops/adk/cmd/autonomy) ───────────────────
autonomy:            __SKIP__  # Top-level CLI module package has no standalone package page; CLI is documented in command pages
autonomy/commands:   __SKIP__  # Command implementations are documented through CLI help and command pages

# ── CI tooling (not exported packages, no mapping needed) ──────────────────
edge/ci:             contributing/guide.md
edge/ci/scan_dependencies: __SKIP__  # CI-only dependency scanner; no user-facing docs page
edge/ci/scan_prohibited:   __SKIP__  # CI-only prohibited-symbol scanner; documented in contributing guide

# ── GUI module (github.com/autonomyops/adk/gui) ────────────────────────────
gui/web:             __SKIP__  # Frontend implementation package; behavior documented in GUI operator pages