Skip to content

docs: fix 20 documentation accuracy issues + add ADR-008#43

Merged
RioPlay merged 1 commit into
mainfrom
fix/doc-accuracy
Jun 20, 2026
Merged

docs: fix 20 documentation accuracy issues + add ADR-008#43
RioPlay merged 1 commit into
mainfrom
fix/doc-accuracy

Conversation

@RioPlay

@RioPlay RioPlay commented Jun 20, 2026

Copy link
Copy Markdown
Owner

Summary

  • commands.adoc: fix asm --depth default (3→2); add missing --surface to mcp install; add missing --scope/--resolution to viz; remove bogus -j alias from viz; add structured flag table to heal; document status savings estimate output
  • ai-integration.adoc: replace stale two-tier Core/Extended MCP model with three-tier Essential/Standard/Full; fix tool tier assignments (search, list, communities, impact-diff were in wrong tier); update env var from ADEN_MCP_FULL=1 to ADEN_MCP_SURFACE; document --surface at install time
  • retrieval-levers.adoc: fix polarity (auto-gating is OFF by default, opt-in via ADEN_LEXICON_ON); reframe ADEN_LEXICON_OFF as kill switch; fix rerank trigger description (code_anchor_fractionquery_looks_codey); fix NL-over-code behavior (expand only, not both levers); document PR feat(search): enable dual-substrate auto-gating by default (opt-out via ADEN_LEXICON_OFF) #39/PR fix(search): guard dual-substrate lexicon levers (opt-in) + index .asc AsciiDoc #40 revert history
  • architecture.adoc: add aden-paths to Mermaid diagram; remove duplicate aden-mcp Phase 2 row
  • security-model.adoc: replace CanPerform (not a valid EdgeType) with Invokes; update malicious-contract-injection threat row to reflect store-first reality
  • .agent/quick-ref.adoc: add --features watch caveat to aden watch entry
  • crates/aden-cli/src/commands/init.rs: fix misleading "built in .aden/store" message — store is in per-user data dir since ADR-003
  • docs/adr-008-current-implementation-state.adoc (new): living state document covering scope extensions beyond original ADRs — Wave 3 edges (Supersedes/Justifies/AssociatedWith, GEN_LOGIC_VERSION=4), store-first architecture, MCP three-tier surface, dual-substrate retrieval (opt-in). Original ADRs left intact as historical records.

All 20 issues validated against source before fixing: aden understand for symbols, Bash for string-literal env vars.

Test plan

  • cargo test --workspace green
  • cargo clippy --workspace clean
  • cargo fmt --all applied

License checklist (required for any Cargo.toml change)

  • No dependency changes — license checklist not applicable

commands.adoc:
- asm --depth default: 3 → 2 (matches code)
- mcp install: add missing --surface <essential|standard|full> flag
- viz: add missing --scope and --resolution flags; remove bogus -j alias
- heal: add structured flag table (--propose/--fix/--gc/--since/--apply/--watch)
- status: document savings estimate output block

ai-integration.adoc:
- Replace two-tier Core/Extended model with three-tier Essential/Standard/Full
- Fix tool assignments: search/list/communities/impact-diff were in wrong tier
- Fix env var: ADEN_MCP_FULL=1 → ADEN_MCP_SURFACE=standard|full (legacy alias noted)
- Document --surface flag at install time

retrieval-levers.adoc:
- Fix polarity: auto-gating is OFF by default, opt-in via ADEN_LEXICON_ON
- Reframe ADEN_LEXICON_OFF as kill switch, not primary disable mechanism
- Fix rerank trigger: code_anchor_fraction → query_looks_codey (query text only)
- Fix NL-over-code behavior: expands only, does not rerank
- Document PR #39/PR #40 revert history in status section

architecture.adoc:
- Add aden-paths node to Mermaid crate diagram
- Remove duplicate aden-mcp Phase 2 row (already shipped as Phase 0)

security-model.adoc:
- Replace CanPerform (not a valid EdgeType) with Invokes in semantics example
- Update malicious-contract-injection threat: moot since store-first (ADR-003)

.agent/quick-ref.adoc:
- Add --features watch caveat to aden watch entry

crates/aden-cli/src/commands/init.rs:
- Fix misleading "Knowledge graph built in .aden/store." message; store is
  in per-user data dir since ADR-003

docs/adr-008-current-implementation-state.adoc (new):
- Document current scope extensions beyond original ADRs: Wave 3 edges
  (Supersedes/Justifies/AssociatedWith), GEN_LOGIC_VERSION=4, store-first
  architecture, MCP three-tier surface, dual-substrate retrieval (opt-in)
@RioPlay RioPlay merged commit c64a242 into main Jun 20, 2026
6 checks passed
@RioPlay RioPlay deleted the fix/doc-accuracy branch June 20, 2026 06:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant