phase 1 5 docs site

Content sources — Phase 1.5 public docs

Maps public Fumadocs pages (`docs/app/content/docs/`) to engineering sources in repo-root `docs/`. Do not wholesale-port future Phase 2+ API spec.

Content sources — Phase 1.5 public docs

Maps public Fumadocs pages (docs/app/content/docs/) to engineering sources in repo-root docs/. Do not wholesale-port future Phase 2+ API spec.

Draft extraction helper: ibex-harness-workspace/docs-app-scripts/port-engineering-content.mjs (--list, --map <slug>).

Getting Started

Public pageSourceNotes
IntroductionDEVELOPMENT_GUIDE.md, /roadmap/current-statePhase 1 honest scope
ConceptsARCHITECTURE.md (overview), GLOSSARY.mdNo memory/LLM forwarding yet
QuickstartMakefile, compose-dev, dev-smoke, DEVELOPMENT_GUIDE.mdD.3.3 — CodeTabs, 501 honesty
FAQNewCommon Phase 1 questions

Architecture

Public pageSource
OverviewARCHITECTURE.md §1–3, PROJECT_CONTEXT.md
ServicesARCHITECTURE.md Core Services, services/*/README.md
Data modelDATABASE_SCHEMA.md (orgs/projects/agents/tokens)
Request lifecycleARCHITECTURE.md, ADR-0011/0012/0013

Proxy

Public pageSource
Overviewservices/proxy/README.md
ConfigurationENVIRONMENT_VARIABLES.md (proxy vars)
AuthenticationADR-0011, services/proxy/README.md
Rate limitingADR-0015
Request routingADR-0012, ADR-0013
Provider adaptersPhase 2 placeholder note

Auth

Public pageSource
Overviewservices/auth/README.md
Issuing API keysADR-0007, token management docs
Org & project modelDATABASE_SCHEMA.md, ADR-0014
Multi-tenant RLSSECURITY.md, migration docs

Security

Public pageSource
OverviewSECURITY.md objectives + threat model
AuthenticationADR-0007, ADR-0010, ADR-0011
Tenant isolationSECURITY.md §5, ADR-0014, ADR-0009
Secrets and keysENVIRONMENT_VARIABLES.md, ADR-0010

Deployment

Public pageSource
Docker Compose (dev)infra/compose/dev/, DEVELOPMENT_GUIDE.md
KubernetesHonest Phase 1 stub — DEPLOYMENT.md future preview
Environment variablesENVIRONMENT_VARIABLES.md (integrator filter)

Operations

Public pageSource
ObservabilityOPS_GUIDE.md, ADR-0019, ADR-0021
TroubleshootingTROUBLESHOOTING.md (compose-dev, auth/proxy, DB)
Health checksADR-0022, MONITORING.md
Incident responserunbooks/RUNBOOKS.md (subset)

API Reference (manual, Wave 13)

Public pageSource
Auth gRPCpackages/proto, API_DOCUMENTATION.md Phase 1 banner
Proxy healthservices/proxy/README.md, ADR-0022
Chat completions stubADR-0012 (501 PROVIDER_NOT_CONFIGURED)
ErrorsADR-0013 error envelope

Deferred: OpenAPI auto-gen from openapi.yaml — file does not exist until Phase 2.

ADRs

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

Changelog & Glossary

Public pageSource
ChangelogCHANGELOG.md Phase 1 entries
GlossaryGLOSSARY.md (Phase 1 terms + future markers)

Stays internal only

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

Public ADRs: /docs/adr. Live status: /roadmap/current-state.

Edit on GitHub

Last updated on

On this page

0%