Wiki Completeness Review
Strong Areas #
- Architecture and contracts. Three-layer architecture, adapter ↔ stack-pack siblings rule, ADR-0005 / ADR-0006 / ADR-0007 / ADR-0012 are all surfaced consistently across concepts, reference, tutorials, and contributing pages.
- Source-of-truth discipline. Every page cites
.docs/files by absolute path with> [!TODO]placeholders where facts could not be verified from the cited sources. The 8-level source-of-truth ordering from CLAUDE.md §9.3 is referenced from contributing/contribution-guide.md and contributing/documentation-standards.md. - Dogfood gate and kit content. Dedicated concept page, diagram, and how-to walk a contributor through the byte-compare invariant, the
src/files/↔ hand-built.claude/mirror, and the v4 base-part reference. - Conformance. Per-level checklists, harness code, AD-STD-CAP-01 v1.0 hardening, and
aidokit doctordrift detection are covered across concepts, reference, and contributing. - Security model. Trust boundaries, capability declarations,
securitySensitivesemantics, the audit log, and the no-LLM / no-telemetry / no-auto-install invariants are surfaced from index.md down through every relevant tutorial and how-to. - CLI surface. Reference page mirrors the v0.1 / v0.5 / v1.0 spec tables with the right dist-tag and
--yesnon-bypass guidance. - Diagrams. All seven required diagrams present (product-map, system-overview, scaffold-flow, adapter-composition, data-flow, dogfood-loop, release-flow), each cross-linked from the concept pages that need them.
Missing Project Details (TODO list) #
- Repository URL for GitHub issues and the marketplace blurb (
wiki/index.md,getting-started/introduction.mdreference).> [!TODO]placeholders are in place. - E2E test lane status. contributing/testing-guidelines.md and how-to-guides/how-to-run-tests-and-byte-compare.md flag this — the
e2e/directory location and CI status are TBD per .docs/ARCHITECTURE.md §18.3. next-jsstack pack mention in concepts/adapters-and-stack-packs.md interactive example — flagged as> [!TODO]because nonext-jspack ships at v1.0.- JSON shape of the
--dry-run --jsonfile plan in how-to-guides/how-to-debug-template-emission.md — flagged> [!TODO]; needs confirmation against the actual CLI output. - Postgres MCP triggers/scope — left "(per spec)" in reference/mcp-catalog-reference.md because the §11 spec entry was not in the read window. Confirm and fill in.
- graphify Codex install recipe —
⏳in the mcp-catalog reference, deferred until Codex MCP surface stabilises per ADR-0015. maintainercapability profile — adapter contract lists Maintainer as MAYdocs-only-writeORscope-limited-write. Per-adapter mapping should be confirmed once Codex / Copilot adapters have stabilised their roles.
Recommended Next Docs #
These would strengthen the wiki without straying from the v1.0 scope:
- A "first PR" worked example under
tutorials/— pick a real shipped change from CHANGELOG.md[Unreleased](e.g. ADR-0015 graphify entry) and walk through every artefact it touched. - A
concepts/multi-adapter-projects.md— multi-adapter is a v1.0 deliverable. Diagram is in diagrams/adapter-composition.md but the conceptual page is implicit, not explicit. - A
reference/state-json-schema.mddocumenting the.aido/state.jsonaudit log shape — currently only referenced inline in concepts/security-model.md and .docs/docs/specs/security-model.md §10.3. - A
how-to-guides/how-to-add-an-adapter.mdthat mirrors theextend-an-adapter.mdtutorial but for an entirely new adapter package — would paralleltutorials/author-a-stack-pack.mdfor the adapter side. - A
concepts/brownfield-flow.md—--brownfieldis shipped in v0.5 but the wiki only references it in passing.
Onboarding Readiness Score #
Score: 9/10
Reason: The wiki gives a new contributor enough to (a) understand what aidokit is and is not, (b) run the CLI locally and inspect the emitted tree, (c) navigate the monorepo to the right package, (d) understand and enforce the dogfood gate, conformance harness, and security boundaries, and (e) ship a change end-to-end with the right ADR/changeset/dogfood/conformance signals. Every load-bearing rule cites its .docs/ source. The point deducted is for the remaining > [!TODO]s (repo URL, E2E status, the Postgres MCP entry detail) and the deliberate absence of brownfield-specific guidance — both fixable in a follow-up PR once the maintainer confirms the missing facts.