# AiMe Documentation Index

This file is the source-of-truth registry for project documentation.

## Document-to-workflow mapping

| Document | Purpose | Related skills | Status |
| --- | --- | --- | --- |
| `README.md` | Project overview and goals | None | Active |
| `docs/DOCUMENTATION_INDEX.md` | Documentation registry | None | Active |
| `docs/IMPLEMENTATION_STATUS.md` | Consolidated implemented evidence, exposed boundaries, explicit non-claims, verification checkpoint, and dependency-ordered next steps | None | Active; paused checkpoint recorded 2026-08-15 |
| `docs/PRODUCT_REQUIREMENTS.md` | Authoritative product goal, scope, non-goals, requirements, and end-state acceptance | None | Draft |
| `docs/CAPABILITY_AND_PERMISSION_MODEL.md` | Read/Modify/Control/Full/Admin authority, confirmation, enforcement, and release policy | None | Draft |
| `docs/ROADMAP.md` | Security-gated delivery phases, dependencies, and acceptance gates | None | Draft |
| `docs/UX_AND_MULTI_DEVICE_PLAN.md` | Local-first hybrid UI, onboarding, devices, profiles, sessions, sharing, and managed-web experience | None | Draft; implementation unlocked by scoped Chat GO |
| `docs/WEB_CONTROL_PLANE_AND_RBAC_PLAN.md` | Managed-mode login, organizations, RBAC, device/profile sharing, leases, tenant isolation, and admin boundaries | None | Draft; implementation unlocked by scoped Chat GO |
| `docs/DEPLOYMENT_AND_UPDATE_PLAN.md` | `kksm2`/Cloudflare deployment, operations, signing, staged automatic updates, and rollback | None | Draft; implementation unlocked by scoped Chat GO |
| `docs/CHAT_FEASIBILITY_GATE_EVIDENCE.md` | Phase 1 local evidence contract, VM preparation facts, manual Chat checklist, and GO/NO-GO record | None | Active; scoped GO recorded 2026-08-13 |
| `docs/ARCHITECTURE.md` | Clean-room architecture and trust boundaries | None | Draft; local Managed pairing/routing, algorithm-agile CNG device identity, protected Windows credential resume, schema-v2 Windows Modify create/structured-apply/preview/replace/rollback plus best-effort SafeFs recovery, native confirmation UI, pending broker, audited stdio host, internal supervised tunnel composition, exact offline MSIX staging, and an unmanaged packaged launcher with offline lifecycle/status/Stop proof implemented; a lower-level Full-risk profile-v2 process-preset start/get/cancel mechanism is verified but production Modify admission is denied pending a Full-session gate or dedicated wrapper; supported Read/Managed defaults remain Read-only, with profile-gated `search_text_files` available on the supported default Read stdio/tunnel route; move/delete, process restart durability/input/Git, production signing/install/live activation, operator repair UX, deployed HTTPS/WSS, login/public service, and real-database-verified durability pending |
| `docs/REFERENCE_PRODUCT_SECURITY_REVIEW.md` | Evidence-backed Khai Hub security review | None | Active research |
| `docs/UNIVERSAL_BODY_REFERENCE_REVIEW.md` | Clean-room Universal Body GPTHAND documentation, UX, and supply-chain review | None | Public-documentation review complete 2026-08-14; clean-room reference only |
| `docs/VM_BEHAVIORAL_TEST_REPORT.md` | Controlled VM observations and dynamic-test evidence | None | Active research |
| `docs/RUN_LOCALLY.md` | Operational quick start for building and running AiMe on Windows with MCP clients | None | Active |

## Source-of-truth order

For the fastest current-state orientation, start with
`IMPLEMENTATION_STATUS.md`. It is a cross-document checkpoint and does not
override the authoritative product, authority, sequencing, UX, deployment, or
architecture sources below.

Use the documents for different questions rather than duplicating their content:

1. `PRODUCT_REQUIREMENTS.md` defines what the product must achieve.
2. `CAPABILITY_AND_PERMISSION_MODEL.md` defines what authority each level may
   exercise and what policy gates it.
3. `ROADMAP.md` defines delivery order and phase exit criteria.
4. `UX_AND_MULTI_DEVICE_PLAN.md` defines the intended user and device/profile
   experience.
5. `WEB_CONTROL_PLANE_AND_RBAC_PLAN.md` defines Managed-mode identity, sharing,
   tenant isolation, and user/organization/platform administration.
6. `DEPLOYMENT_AND_UPDATE_PLAN.md` defines the planned `kksm2` hosting and signed
   client release/update lifecycle.
7. `CHAT_FEASIBILITY_GATE_EVIDENCE.md` records the hard-gate evidence and final
   manual GO/NO-GO decision.
8. `ARCHITECTURE.md` defines the currently selected technical design and actual
   prototype boundary.
9. The reference-product reports contain evidence, not AiMe requirements.

The Phase 1 Chat feasibility gate in `ROADMAP.md` recorded a scoped `GO` on
2026-08-13. Later phases are now sequenced by their own capability, security,
deployment, and release gates; the Chat result does not waive those gates.

## Planned evidence-backed documents

- Per-capability threat models and post-gate security acceptance evidence.
- Tunnel-client packaging and runtime-key operational runbook.
- Production signing, install/live-activation, update, rollback, and recovery
  runbook; offline staging and unsigned MakeAppx evidence are recorded in the
  deployment plan.
- `kksm2` preflight, deployment evidence, backup/restore rehearsal, and
  operations runbook.
- Unified Chat target-routing threat model, only if that data-plane option is
  approved.

## Governance rules

- Register new documentation here in the same change that creates it.
- Prefer updating an existing document over creating a duplicate.
- Clearly label observed facts, inferences, assumptions, and design decisions.
- Reconcile product, permission, roadmap, UX, and architecture documents when a
  decision changes across their boundaries.
- Never commit credentials, OAuth tokens, personal prompts, raw secrets, or
  proprietary reference-product binaries.
- Keep third-party evidence attributable by URL, version, date, and checksum.
