Status: maintained Applies to: OpenPath repository Last verified: 2026-04-13 Source of truth:
docs/INDEX.md
- Repo overview:
README.md - LLM agent workflow:
AGENTS.md - Contribution guide:
CONTRIBUTING.md - Code of conduct:
CODE_OF_CONDUCT.md - Project roadmap:
ROADMAP.md - Security policy:
SECURITY.md - Licensing:
LICENSING.md
- ADR index:
docs/ADR.md - Transactional service writes:
docs/adr/0009-transactional-service-writes.md - Public SPA extension surface:
docs/adr/0010-public-spa-extension-surface.md - Unified failure semantics (protected mode):
docs/adr/0011-unified-failure-semantics.md - Group role join table plan:
docs/group-role-join-table-plan.md - Environment variable registry:
docs/ENVIRONMENT_VARIABLES.md - Agent config parity (cross-platform key mapping):
docs/agent-config-parity.md - Extension <-> native host message contract:
docs/extension-native-host-contract.md - API package guide:
api/README.md - Shared package guide:
shared/README.md - Dashboard package guide:
dashboard/README.md
- How-to guide:
docs/HOWTO.md - Troubleshooting:
docs/TROUBLESHOOTING.md - CI/CD runner timing and artifact measurement:
docs/ci-cd-runner-measurement.md - Pre-push e2e scoping (path-scoped Playwright stage):
docs/pre-push-e2e-scoping.md - Source-text contract test inventory:
docs/contract-tests.md - Student-policy contract matrix:
docs/testing/student-policy-contract-matrix.md - WEDU captive portal lab:
docs/testing/wedu-captive-portal-lab.md - WEDU gateway VM provisioning:
docs/testing/wedu-captive-portal-lab-provisioning.md - Shared workspace hypothesis-validation wrapper:
../scripts/validate-hypothesis.shfrom the workspace root when working insideWhitelist/ - Direct Windows runner diagnostic:
scripts/run-windows-runner-direct.mjs - Migration notes:
docs/MIGRATION.md - Security hardening:
docs/SECURITY-HARDENING.md - APT signing key workflow:
docs/apt-signing-key.md - Linux runtime library load order:
docs/linux-load-order.md - Linux deployment notes:
linux/DEPLOYMENT.md - Linux troubleshooting:
linux/TROUBLESHOOTING.md - Windows deployment notes:
windows/DEPLOYMENT.md - Windows troubleshooting:
windows/TROUBLESHOOTING.md - Windows outbound egress floor (opt-in + canary):
docs/windows-egress-floor.md
- OSS adoption path for technical evaluators:
docs/evaluation/adoption-path.md - Self-hosting prerequisites:
docs/evaluation/self-hosted-prerequisites.md - Deployment shapes:
docs/evaluation/deployment-shapes.md - Support and ownership boundaries:
docs/evaluation/support-boundaries.md - Security and hardening baseline:
docs/SECURITY-HARDENING.md - Public OSS security policy:
SECURITY.md
- React SPA:
react-spa/README.md - Linux agent:
linux/README.md - Windows agent:
windows/README.md - Firefox extension:
firefox-extension/README.md - Firefox AMO submission notes:
firefox-extension/AMO.md - Firefox extension privacy policy:
firefox-extension/PRIVACY.md - E2E/contract test inventory:
tests/e2e/README.md
- Canonical docs are maintained in English.
- Historical files such as
../CHANGELOG.mdand most ADR records provide context, not current operator instructions. - Active plan files under
docs/plans/are working artifacts and are not part of the canonical doc set. - Repo-process docs under
.github/and packageAGENTS.mdfiles are workflow references, not product runbooks. docs/adr/template.mdis a template, not a current architecture contract.- ADR numbering is inherited and not strictly sequential; use titles and links, not numeric assumptions.