Skip to content

docs: realign roadmap + commands + limitations with v1.6.0 ship state - #362

Merged
robotrocketscience merged 4 commits into
mainfrom
docs/issue-360-realign-v160
May 3, 2026
Merged

docs: realign roadmap + commands + limitations with v1.6.0 ship state#362
robotrocketscience merged 4 commits into
mainfrom
docs/issue-360-realign-v160

Conversation

@robotrocketscience

@robotrocketscience robotrocketscience commented May 2, 2026

Copy link
Copy Markdown
Owner

Closes #360.

What

pyproject.toml on main is at 1.6.0 (released 2026-05-02). Several docs still described v1.6 as "planned" with the wrong scope, and a few smaller items had drifted off the actual code. This PR realigns the docs.

Drifts fixed

  1. README + docs/ROADMAP roadmap rowsv1.5.x and v1.6 were marked planned; both shipped (v1.5.1 and v1.6.0 respectively). v1.7 row absorbs the graph items ([retrieval] Signed normalized Laplacian + offline eigenbasis (top-K=200) builder #149 / [retrieval] Heat kernel authority signal via precomputed eigenbasis (signed Laplacian) #150 / [v1.5 prereq for #152] Port Plate FFT HRR primitives to public repo #216) that did not ship in v1.6.
  2. docs/ROADMAP "What shipped" / "Planned" sections — moved v1.5.0 / v1.5.1 / v1.6.0 prose into "What shipped"; rewrote v1.7.0 prose to reflect the combined graph-signal-wave + structural-retrieval-lane scope.
  3. docs/ROADMAP recovery-inventory rows — version targets aligned with where features actually shipped (or are now scheduled).
  4. docs/LIMITATIONS — posterior-ranking section: harness + heat-kernel composition wiring shipped at v1.6.0 default-OFF ([retrieval] Posterior-weighted ranking via Beta-Bernoulli prior (log-additive, weight 0.5) #151, feat: posterior-ranking eval harness — MRR uplift + ECE — slice 1 of #151 #306, feat: heat-kernel composition into log-additive ranking score (slice 2 of #151) #310); default-flip lands at v1.7.0 ([retrieval] Pipeline composition tracker — unified retrieve() with feature-flag gate #154), not v2.0.0.
  5. docs/COMMANDS — count 24 → 26; new rows for tail ([v1.5.x] Injection log + aelf tail — live observability for hook-injected memory blocks #321) and sweep-feedback ([phantom-prereqs T2] Implicit retrieval-driven feedback — sweeper + grace window #191); onboard row updated for v1.5.1 [v1.5] Default-on LLM-Haiku onboard via Claude Code Haiku subagents (no API key) #238 (default-on host-driven classification, no API key required); doctor row documents --gc-orphan-feedback (feedback_history has 100% orphan belief_ids; audit trail is structurally broken #223) and --promote-retention (Rebuild redesign: belief typing + aging policy #290 phase-3); --advanced hidden-subcommand list adds sweep-feedback.
  6. README budget line2,000 → 2,400 to match DEFAULT_TOKEN_BUDGET in src/aelfrice/retrieval.py:97. docs/COMMANDS "Defaults that matter" budget row gets the same value plus the constant reference.
  7. docs/CLI_SURFACE_AUDIT — historical banner. The memo was authored against v1.2.0; consolidation it proposed landed in v1.3.0.

Out of scope

Verification

  • git diff github/main is docs-only across the five files.
  • All four commits SSH-signed.
  • Discretion grep clean against the parallel-session reserved-vocabulary set.

Summary by Sourcery

Realign roadmap, limitations, and CLI documentation with the v1.6.0 release state and planned v1.7.0 scope.

Documentation:

  • Update ROADMAP to mark v1.5.1 and v1.6.0 as shipped, describe their actual shipped scope, and shift graph and structural retrieval work to v1.7.0.
  • Clarify posterior-weighted ranking timelines, distinguishing the v1.6.0 eval harness and heat-kernel wiring from the v1.7.0 default-on flip.
  • Document the v1.5.1 default-on host-driven onboard classifier and adjust feature timelines in the recovery-inventory tables accordingly.
  • Refresh COMMANDS docs to cover the full 26-command surface, including tail, sweep-feedback, new doctor flags, and the host-driven onboard path.
  • Increase the documented retrieval token budget from 2,000 to 2,400 tokens in README and COMMANDS defaults to match the current implementation.
  • Mark the CLI surface audit memo as historical and point readers to the up-to-date COMMANDS reference.
  • Update LIMITATIONS to reflect the v1.6.0 posterior-ranking eval harness and default-off status ahead of the v1.7.0 default flip.

@sourcery-ai

sourcery-ai Bot commented May 2, 2026

Copy link
Copy Markdown

Reviewer's Guide

Realigns README and docs (ROADMAP, COMMANDS, LIMITATIONS, CLI_SURFACE_AUDIT) with the v1.6.0 shipped state: marking v1.5.1 and v1.6.0 as shipped, pushing graph/HRR work to v1.7, updating posterior-ranking and retrieval-budget descriptions, and documenting new/changed CLI commands and historical context for the CLI surface audit memo.

Sequence diagram for v1_6_0 hook_audit_and_tail_observability_flow

sequenceDiagram
    actor User
    participant HostTooling as Host_tooling
    participant AelfHooks as Aelf_hooks
    participant AuditLog as Hook_audit_jsonl
    participant TailCmd as aelf_tail

    User->>HostTooling: Trigger git operation or editor action
    HostTooling->>AelfHooks: Invoke aelf hooks
    AelfHooks->>AelfHooks: Render hook memory block
    AelfHooks->>AuditLog: Append audit record
    AelfHooks-->>HostTooling: Return hook result

    User->>TailCmd: Run "aelf tail --since DUR --filter EXPR"
    TailCmd->>AuditLog: Open and stream new records
    loop For each matching record
        AuditLog-->>TailCmd: Emit audit entry
        TailCmd->>User: Print summary line (or full block with --full)
    end
Loading

Flow diagram for roadmap features across versions v1_3_0_to_v1_7_0

flowchart LR
    subgraph v1_3_0["v1.3.0 — retrieval wave"]
        v13_entity["Entity index (L2.5)"]
        v13_bfs["BFS multi-hop graph traversal"]
        v13_llm_onboard_optin["LLM-Haiku onboard classifier (opt-in)"]
        v13_posterior_partial["Posterior-weighted ranking (partial)"]
    end

    subgraph v1_4_0["v1.4.0 — context rebuilder"]
        v14_rebuilder["PreCompact retrieval-curated continuation"]
        v14_trigger["Manual + threshold trigger"]
        v14_fidelity["Continuation-fidelity scorer"]
    end

    subgraph v1_5_0["v1.5.0 — retrieval plumbing"]
        v15_pipeline["Pipeline composition tracker (unified retrieve)"]
        v15_bm25f["BM25F anchor-text + vectorized BM25"]
        v15_search_hook["Search-tool matcher extension"]
        v15_dynamic_repark["Dynamic-trigger re-park"]
    end

    subgraph v1_5_1["v1.5.1 — corroboration + host-driven onboard"]
        v151_corroboration["Belief corroboration tracking"]
        v151_host_llm_default["Host-driven LLM onboard classifier (default-on)"]
    end

    subgraph v1_6_0["v1.6.0 — hardening, observability, retention"]
        v16_hook_contract["Hook-hardening framing-tag contract"]
        v16_audit_log["Per-turn hook audit log"]
        v16_tail_cmd["aelf tail command"]
        v16_retention_class["Belief retention class"]
        v16_rebuild_logs["Rebuild diagnostic logs"]
        v16_posterior_harness["Posterior-ranking eval harness"]
        v16_heat_kernel_wiring["Heat-kernel composition wiring (default-OFF)"]
        v16_deferred_sweeper["Deferred-feedback sweeper"]
        v16_v20_corpus["v2.0 corpus scaffold + bench-gate"]
        v16_replay_probe["replay_full_equality probe"]
        v16_session_id["Session_id propagation to beliefs"]
        v16_reachable_install["Reachable-install detection"]
    end

    subgraph v1_7_0["v1.7.0 — graph signal wave + structural retrieval lane"]
        v17_laplacian["Signed normalized Laplacian builder"]
        v17_heat_kernel["Heat-kernel authority signal (default-ON)"]
        v17_plate_hrr["Plate FFT HRR primitives"]
        v17_hrr_lane["HRR structural-query lane"]
        v17_uri_baki["uri_baki post-rank adjuster retest"]
        v17_posterior_flip["Posterior-weighted ranking default-flip"]
        v17_bench_flip["Benchmark-gate default-on flip"]
    end

    %% Posterior-ranking evolution
    v13_posterior_partial --> v16_posterior_harness --> v16_heat_kernel_wiring --> v17_posterior_flip

    %% Graph and HRR features re-targeted from v1.6.0 to v1.7.0
    v15_pipeline --> v17_laplacian
    v15_pipeline --> v17_heat_kernel
    v15_pipeline --> v17_plate_hrr
    v17_plate_hrr --> v17_hrr_lane

    %% Feedback and retention chain
    v151_corroboration --> v16_deferred_sweeper
    v16_deferred_sweeper --> v16_posterior_harness
    v16_retention_class --> v17_uri_baki

    %% Observability chain
    v16_hook_contract --> v16_audit_log --> v16_tail_cmd

    %% Corpus and reproducibility chain
    v16_v20_corpus --> v17_bench_flip
Loading

File-Level Changes

Change Details Files
Update roadmap tables and narrative to reflect v1.5.1 and v1.6.0 as shipped releases and move graph/HRR work to v1.7.0.
  • Extend the roadmap version table with a v1.5.1 row and change the v1.6.0 row from planned graph wave to shipped hardening/observability scope.
  • Refactor the v1.5.x, v1.6.0, and v1.7.0 narrative sections to describe actual shipped features vs. planned graph/structural work, and add a new v1.7.0 section that now owns the graph-signal and structural-lane scope.
  • Update the recovery-inventory table so default-on host-driven onboard classification is at v1.5.1, posterior-weighted ranking is split across v1.3.0, v1.6.0 (eval harness + wiring, default-OFF), and v1.7.0 (default-ON), and signed Laplacian + heat-kernel authority moves to v1.7.0.
docs/ROADMAP.md
Clarify posterior-ranking limitations and versioning around the eval harness and heat-kernel composition wiring.
  • Expand the v1.3.0 posterior-ranking limitation text to describe the v1.6.0 eval harness location and the heat-kernel composition wiring as default-OFF.
  • Document that the default-on flip for posterior-weighted ranking is gated on v2.0 corpus thresholds and lands at v1.7.0.
docs/LIMITATIONS.md
Bring the CLI command reference in sync with the current surface and defaults, including new commands, flags, and token budget.
  • Increase the stated number of CLI subcommands from 24 to 26.
  • Update the onboard command description to reflect v1.5.1 default-on host-driven LLM classification with no API key, and clarify flags and host/regex fallback behavior.
  • Extend the doctor description with v1.6+ maintenance flags --gc-orphan-feedback and --promote-retention.
  • Add new entries for tail and sweep-feedback with their v1.6+ behavior and context.
  • Include sweep-feedback in the --advanced hidden-subcommand list.
  • Change the documented retrieval token budget from 2,000 to 2,400 and reference the DEFAULT_TOKEN_BUDGET constant.
docs/COMMANDS.md
Sync README roadmap and token-budget description with the shipped v1.5.1 and v1.6.0 scope and retrieval defaults.
  • Update the default retrieval token budget in the README from 2,000 to 2,400 tokens per prompt.
  • Adjust the roadmap rows so v1.5.x is marked shipped with host-driven onboard classification in v1.5.1, v1.6 is marked shipped as hardening + observability, and v1.7 holds the graph wave and structural retrieval lane scope.
README.md
Mark the CLI surface audit doc as a historical v1.3-era design memo and point readers to the current command reference.
  • Add a leading note stating that the memo reflects the v1.3.0 consolidation design and is now stale, with v1.5.x and v1.6.0 changes called out and a pointer to COMMANDS.md as the current spec.
docs/CLI_SURFACE_AUDIT.md

Assessment against linked issues

Issue Objective Addressed Explanation
#360 Update README roadmap rows and docs/ROADMAP.md so that v1.5.x and v1.6.0 are marked as shipped with their actual shipped scope, and v1.7.0 absorbs the graph-related items (#149/#150/#216), including aligning the ROADMAP "What shipped" section and recovery-inventory rows with these versions.
#360 Update documentation about posterior-ranking and evaluation so that LIMITATIONS.md and ROADMAP.md correctly describe the v1.6.0 shipped eval harness + heat-kernel composition (default-OFF) and the v1.7.0 default-flip, instead of treating full eval as purely v2.0.0.
#360 Update CLI and configuration docs (COMMANDS.md, README.md, CLI_SURFACE_AUDIT.md) to match the current CLI surface and defaults: 26 subcommands including tail and sweep-feedback, correct description of onboard LLM classification default-on host-driven behavior from v1.5.1, doctor’s new flags, and retrieval token budget 2400 everywhere, and mark CLI_SURFACE_AUDIT.md as a historical v1.3-era memo.

Possibly linked issues


Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented May 2, 2026

Copy link
Copy Markdown

Important

Review skipped

Ignore keyword(s) in the title.

⛔ Ignored keywords (2)
  • docs:
  • release:

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: bbc5c71c-b314-42a2-bece-f8696dce0a4c

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/issue-360-realign-v160

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@robotrocketscience robotrocketscience added the attn:review Needs review (PR open, awaiting reviewer) label May 2, 2026

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • The new banner in CLI_SURFACE_AUDIT.md says aelf tail and sweep-feedback were added in v1.5.x, but the roadmap and commands docs describe them as v1.6.0 additions—worth aligning the version references across these docs.
  • In COMMANDS.md, the advanced --help list adds sweep-feedback but not tail; if tail is also intended to be hidden/advanced, it should be listed there, otherwise clarify its visibility so the described subcommand count and surfaces stay consistent.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The new banner in `CLI_SURFACE_AUDIT.md` says `aelf tail` and `sweep-feedback` were added in v1.5.x, but the roadmap and commands docs describe them as v1.6.0 additions—worth aligning the version references across these docs.
- In `COMMANDS.md`, the advanced `--help` list adds `sweep-feedback` but not `tail`; if `tail` is also intended to be hidden/advanced, it should be listed there, otherwise clarify its visibility so the described subcommand count and surfaces stay consistent.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions Bot added the attn:merge-conflict PR branch needs rebase label May 2, 2026
@github-actions

github-actions Bot commented May 2, 2026

Copy link
Copy Markdown

This PR is now behind main. Rebase locally so your commit signatures stay intact:

git fetch origin && git checkout 'docs/issue-360-realign-v160' && git rebase origin/main
# resolve conflicts if any, then
git push --force-with-lease

Auto-rebase was removed because the bot has no signing key; rebasing as the bot strips author signatures and the required_signatures rule on main then blocks the merge. See #341.

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[claim:review:Toug:2026-05-03T03:25:55Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[claim:review:Kulili:2026-05-03T03:26:12Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[release:review:Kulili:2026-05-03T03:26:17Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[claim:review:Gylf:2026-05-03T03:26:22Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[release:review:Gylf:2026-05-03T03:26:27Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[claim:review:Setr:2026-05-03T03:28:48Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[release:review:Setr:2026-05-03T03:28:52Z]

@robotrocketscience
robotrocketscience force-pushed the docs/issue-360-realign-v160 branch from 909617f to 33e2c62 Compare May 3, 2026 03:29
@yoshi280 yoshi280 removed the attn:merge-conflict PR branch needs rebase label May 3, 2026
@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

Reviewed (Toug). Diff verified accurate: pyproject 1.6.0 ✓, DEFAULT_TOKEN_BUDGET 2400 ✓ (src/aelfrice/retrieval.py:97), 26 subcommands counted in src/aelfrice/cli.py ✓, tail (#321) and sweep-feedback exist on main ✓. Discretion grep clean (Haiku hits are pre-existing public references to the documented LLM onboard classifier feature, not reserved vocabulary).

Branch was 2 commits behind main (exp/uri_baki #153 — zero file overlap with this docs PR). Rebased locally, all 4 commits re-signed, force-pushed. New head: 33e2c62. Awaiting fresh staging-gate run before FF merge.

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[claim:review:Kulili:2026-05-03T03:30:15Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[release:review:Kulili:2026-05-03T03:30:20Z]

)

v1.5.x and v1.6 rows describe the actual scope shipped (host-driven
onboard, hardening + observability, retention class, posterior eval
harness, sweeper, bench-gate). Graph-signal wave (#149/#150/#216) +
HRR/uri_baki/bench-gate flip (#152/#153/#154) move into a single
v1.7.0 row. README default-budget line corrected 2,000 → 2,400 to
match DEFAULT_TOKEN_BUDGET in src/aelfrice/retrieval.py.

No code changes.
…tate (#360)

The MRR-uplift + ECE-calibration eval harness and heat-kernel
composition wiring shipped at v1.6.0 (#151, #306, #310), both
default-OFF. Default-flip moves to v1.7.0 (#154). Previous text
predicted both lands at v2.0.0.
…budget (#360)

Subcommand count 24 → 26 (adds aelf tail #321, sweep-feedback #191).
onboard --llm-classify row reflects the v1.5.1 default-on host-driven
path (#238); doctor row mentions --gc-orphan-feedback (#223) +
--promote-retention (#290 phase-3); sweep-feedback added to advanced
help-flag list. Defaults table: retrieval token budget 2,000 → 2,400
to match DEFAULT_TOKEN_BUDGET in src/aelfrice/retrieval.py.
Memo targeted the v1.3.0 visible/hidden split; the CLI surface has
moved on through v1.5.x and v1.6.0. Banner at the top points to
COMMANDS.md as the current reference.
@robotrocketscience
robotrocketscience force-pushed the docs/issue-360-realign-v160 branch from 33e2c62 to 6d7bc40 Compare May 3, 2026 03:30
@robotrocketscience
robotrocketscience merged commit 6d7bc40 into main May 3, 2026
17 checks passed
@robotrocketscience
robotrocketscience deleted the docs/issue-360-realign-v160 branch May 3, 2026 03:33
@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[release:review:Toug:2026-05-03T03:33:15Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[claim:review:Gylf:2026-05-03T03:35:09Z]

@yoshi280

yoshi280 commented May 3, 2026

Copy link
Copy Markdown
Collaborator

[release:review:Gylf:2026-05-03T03:35:33Z]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

attn:review Needs review (PR open, awaiting reviewer)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: realign roadmap + limitations + commands with v1.6.0 ship state

2 participants