docs: close SOT coverage gaps (content-drift, sanctum, Tier 2 injection, README discoverability)#191
Merged
Merged
Conversation
…on, README discoverability) - Add docs/CONTENT-DRIFT.md — operator guide for the aim-content-drift skill: drift classes (MISSING/SUPERSEDED/ORPHAN), never-clobber guarantee, --ack workflow, v1 ORPHAN heuristic limit, --apply deferred to v1.1. - Add docs/SANCTUM-SKILLS.md — sanctum file lifecycle: aim-agent-sanctum-init (First Breath scaffold, 8 files, idempotency) + aim-lore-hygiene (LORE/MEMORY compaction). - docs/HOOKS.md: new "Tier 2 Per-Turn Context Injection" section documenting context_injection_tier2.py / injection.py — adaptive budget, confidence gating, topic drift, collection routing, greedy fill, the per-source budget ledger and remaining= reject marker, and the injection-log.jsonl schema. Corrects the prior UserPromptSubmit description, which described only activity logging. - README.md: link 4 previously-unlinked docs (temporal features, multi-IDE, backup/restore, architecture); point the Parzival link at README-POV.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes the P1 documentation source-of-truth gaps surfaced by a docs-coverage audit (13 gaps across 30 system aspects; this PR covers the 8 P1 gaps).
What
docs/CONTENT-DRIFT.md— operator guide for theaim-content-driftskill: the three drift classes, the never-clobber guarantee, the--ackworkflow, the v1 ORPHAN heuristic limit, and the v1.1-deferred--apply.docs/SANCTUM-SKILLS.md— the sanctum file lifecycle:aim-agent-sanctum-init(First Breath scaffold, 8 files, file-level idempotency) andaim-lore-hygiene(LORE/MEMORY compaction; distinct fromaim-purge).docs/HOOKS.md— new "Tier 2 Per-Turn Context Injection" section documenting the per-turn semantic retrieval hook (adaptive budget, confidence gating, topic drift, collection routing, greedy fill, the per-source budget ledger, theremaining=reject marker, and theinjection-log.jsonlschema). Also corrects the priorUserPromptSubmitdescription, which described only activity logging and omitted this hook.README.md— links four previously-unlinked docs (temporal features, multi-IDE support, backup/restore, architecture) and points the Parzival link atREADME-POV.md.Why
Several substantial docs were undiscoverable from the README, and two subsystems (content-drift, the Tier 2 injection budget/ledger) had no source-of-truth page. Each aspect of the system should have a discoverable SOT doc.
Verification
Each new/changed section was reviewed for technical accuracy against the source (
injection.py,context_injection_tier2.py, the skillSKILL.mdfiles): symbol names, gating modes, theper_sourceledger semantics, and the reconciliation example were verified against the code. All README link targets resolve.