phase 1 5 docs site

Content coverage map — public docs

Tracks the current public docs corpus against implementation-native sources after the late Phase 2 docs realignment.

Content coverage map — public docs

Tracks public Fumadocs pages (web/content/docs/) against the sources that should keep them honest. Phase 1.5 seeded much of the site from engineering markdown; after the late-Phase-2 proxy work, docs should prefer implementation-native sources where available (services/*/README.md, packages/*, proto contracts, and accepted ADRs).

Treat this file as a living coverage map, not a one-time Phase 1.5 porting plan.

Coverage status

AreaCurrent source of truthCoverage statusNotes
Getting startedweb/content/roadmap/current-state.mdx, Makefile, services/auth/README.md, services/proxy/README.mdCurrentRebaselined for mock/live Phase 2; FAQ/quickstart no longer teach 501 as happy path
Architectureservices/README.md, services/*/README.md, accepted ADRsCurrentOverview/lifecycle updated for forwarding, sessions, traces
Proxyservices/proxy/README.md, services/proxy/internal/http/, packages/directive, packages/injection, packages/authcache, packages/idempotency, packages/sessionCurrentFeature deep-dives shipped for directives, sessions, auth cache, traces
Authservices/auth/README.md, packages/proto/proto/ibex/auth/v1/auth.proto, accepted ADRsCurrentProto-backed gRPC reference + issuing keys guides
Deployment / opsservices/*/.env.example, infra/compose/dev/.env.example, services/proxy/internal/config/, packages/clickhouse, packages/metrics, packages/telemetryCurrentEnv docs + compose smoke path match late Phase 2
API referenceManual MDX + proto (auth.proto) + HTTP route inventoryCurrentBehavioral pages + /docs/api-reference/http-routes; OpenAPI / fumadocs-openapi deferred until CI-validated spec

Getting Started

Public pageSourceNotes
Introduction/roadmap/current-state, services/README.mdLate-Phase-2 capability boundary
Conceptsservices/README.md, services/proxy/README.md, web/engineering/GLOSSARY.mdDistinguishes shipped proxy features from Phase 3 memory
QuickstartMakefile, compose-dev, services/auth/README.md, services/proxy/README.mdMock-mode happy path; live optional
FAQCurrent docs corpus + issue/PR feedbackMock/live + unregistered-model 501

Architecture

Public pageSource
Overviewservices/README.md, accepted ADRs, /roadmap/current-state
Servicesservices/*/README.md, packages/README.md
Data modelweb/engineering/DATABASE_SCHEMA.md plus session/directive ADRs
Request lifecycleservices/proxy/README.md, ADR-0011/0012/0013/0031/0035

Proxy

Public pageSource
Overviewservices/proxy/README.md
Configurationservices/proxy/.env.example, services/proxy/internal/config/, services/proxy/README.md
AuthenticationADR-0011, ADR-0028, ADR-0029, services/proxy/README.md
Rate limitingADR-0015, packages/ratelimit/
Request routingservices/proxy/README.md, ADR-0012, ADR-0013, ADR-0031, ADR-0035
Provider adapterspackages/provider/, packages/provider/openai/, ADR-0025/0026/0027

Auth

Public pageSource
Overviewservices/auth/README.md
Issuing API keysADR-0007, token management docs
Org & project modelweb/engineering/DATABASE_SCHEMA.md, ADR-0014
Multi-tenant RLSweb/engineering/SECURITY.md, migration docs

Security

Public pageSource
Overviewweb/engineering/SECURITY.md objectives + threat model
AuthenticationADR-0007, ADR-0010, ADR-0011
Tenant isolationweb/engineering/SECURITY.md §5, ADR-0014, ADR-0009
Secrets and keysweb/engineering/ENVIRONMENT_VARIABLES.md, ADR-0010

Deployment

Public pageSource
Docker Compose (dev)infra/compose/dev/, web/engineering/DEVELOPMENT_GUIDE.md
KubernetesHonest future-facing stub until production manifests become authoritative
Environment variablesservices/*/.env.example, services/proxy/internal/config/, services/auth/internal/config/

Operations

Public pageSource
Observabilitypackages/metrics/, packages/telemetry/, services/proxy/internal/http/trace/, ADR-0019/0021/0033
Troubleshootingweb/engineering/TROUBLESHOOTING.md, services/auth/README.md, services/proxy/README.md
Health checksADR-0022, packages/healthcheck/
Incident responseweb/engineering/runbooks/RUNBOOKS.md (subset)

API Reference (manual + contract-backed)

Public pageSource
HTTP route inventoryservices/proxy/internal/http/router.go, router_protected.go
Auth gRPCpackages/proto/proto/ibex/auth/v1/auth.proto, services/auth/README.md
Proxy healthservices/proxy/README.md, ADR-0022
Chat completionsservices/proxy/README.md, services/proxy/internal/http/router.go, ADR-0012/0013/0031/0035
ErrorsADR-0013 error envelope, packages/provider/errors.go, packages/provider/map_error.go

Deferred: OpenAPI auto-generation stays out of scope until a maintained openapi.yaml exists and is CI-validated against implemented routes.

ADRs

Public pageSource
ADR index + 0002–0023docs/adr/ → migrated to web/content/docs/adr/

Changelog & Glossary

Public pageSource
ChangelogCHANGELOG.md plus release parser pipeline
Glossaryweb/engineering/GLOSSARY.md plus current docs corpus

Stays internal only

  • web/engineering/CODING_STANDARDS.md, web/engineering/FILE_STRUCTURE.md, web/engineering/TESTING_STRATEGY.md
  • web/engineering/DEPENDENCIES.md, web/engineering/PERFORMANCE.md, web/engineering/TOOLCHAIN.md, web/engineering/UI_UX_GUIDELINES.md
  • Full web/engineering/DATABASE_SCHEMA.md, web/engineering/API_DOCUMENTATION.md Phase 2+ surfaces
  • web/engineering/SECURITY-CI-GATES-DELIVERABLES.md, CI audit registers
  • Contributor workspace prompts (not published)

Public ADRs: /docs/adr. Canonical short-form status: /roadmap/current-state.

Edit on GitHub

Last updated on

On this page

0%