Skip to content

docs: v3.0.1 sweep — README Status + ROADMAP rows (#791) - #794

Merged
github-actions[bot] merged 3 commits into
mainfrom
docs/issue-791-v3.0.1-sweep
May 14, 2026
Merged

docs: v3.0.1 sweep — README Status + ROADMAP rows (#791)#794
github-actions[bot] merged 3 commits into
mainfrom
docs/issue-791-v3.0.1-sweep

Conversation

@robotrocketscience

Copy link
Copy Markdown
Owner

Closes #791 (partial — see "What's still open" below)

Docs sweep for v3.0.1. Three atomic commits closing the highest-signal staleness from the #791 checklist.

What's in the diff

  1. docs(readme): bump Status section v3.0.0 -> v3.0.1 — README line 169 still pointed at v3.0.0 as the latest stable; v3.0.1 has been tagged + published to PyPI + GitHub-released since 2026-05-13.
  2. docs(roadmap): add v3.0.1 row to versions-at-a-glance table — ROADMAP's table ended at v3.0.0. New row carries the same theme phrasing as v3.0.0.
  3. docs(roadmap): add v3.0.1 'What shipped' subsection — Mirrors the v3.0.0 subsection: one framing paragraph + per-feature bullets (Collapse install/upgrade surface to uv-only #730 install collapse, Auto-migrate non-uv aelfrice installs to uv tool on first 3.0.1 setup #733/fix(lifecycle): runnable uv install one-liner when maybe_migrate_to_uv hits uv-not-found #774 auto-migrate, Flip default: search-tool + search-tool-bash hooks on by default #738 default-on agent-side retrieval, Cross-fire injection dedup: amortize search hooks against the UPS-fire memory block #740 dedup ring, authlib CVE-2026-44681 bump).

What's NOT in this PR (verified non-stale)

Items from the #791 checklist that I checked against github/main b2287ef6 and found already-current:

  • README.md headline NOTE (> v1.0 ships the surface ...) — no such line exists in the README; the checklist item points at copy that's already been removed.
  • README.md Install / 60-seconds blocks — already uv tool install aelfrice per the Collapse install/upgrade surface to uv-only #730 collapse; no new install-time commands shipped in v3.0.1.
  • docs/INSTALL.md optional extras / post-install verification — already references v3.0.1+ at the search-tool hook rows (lines 146-147).
  • docs/RELEASING.md pytest count — the file deliberately doesn't pin a count (uv run pytest tests/ -x -q # track the actual count in CI), so there's nothing to refresh.
  • docs/COMMANDS.md — every CLI subcommand that ships on github/main is already documented; the opening paragraph doesn't carry a total count.
  • docs/MCP.md — "fifteen memory tools" matches @mcp.tool decorator count in src/aelfrice/mcp_server.py (15).
  • docs/SLASH_COMMANDS.md — "Nineteen markdown files" matches src/aelfrice/slash_commands/*.md count (19).
  • docs/BENCHMARKS.md activation-status / version label — no adapter status changed in v3.0.1.
  • docs/LIMITATIONS.md — none of the listed known-issue items shipped a resolution in v3.0.1.

The "next-version" rows in README/ROADMAP point at v3.1 work that hasn't crystallised yet — keeping the existing pointers is the right call until v3.1 scope ratifies.

Verification

  • 3 atomic commits, all SSH-signed (G).
  • Diff: 2 files, +12 / -1.
  • pytest tests/ unaffected (docs-only).
  • Discretion grep on diff vs github/main: clean.
  • README.md / ROADMAP.md byte-checked against current state and CHANGELOG.md § 3.0.1.

Out of scope

v3.0.1 fully released 2026-05-14T15:53Z (tag 2026-05-13T20:41Z, PyPI publish 2026-05-13T20:42Z run 25825264439). The README Status section still pointed at v3.0.0 as the latest stable. Bump both the version label and the CHANGELOG anchor in the per-entry-detail link.
v3.0.1 shipped 2026-05-13 (pipx-no-more install-surface collapse #730 + auto-migrate #733 + follow-up #774; search-tool/Bash hooks default-on #738; cross-fire dedup ring #740; authlib CVE-2026-44681 bump). The roadmap table ended at v3.0.0 with no v3.0.1 row even though the CHANGELOG and README already track it.
Mirrors the v3.0.0 subsection structure: one paragraph framing the release plus a per-feature bullet list (install-surface collapse #730, auto-migrate #733/#774, default-on agent-side retrieval hooks #738, cross-fire dedup ring #740, transitive authlib CVE-2026-44681 bump). Sits under '## Planned' for consistency with v3.0.0 — the section name has been a misnomer since v1.7.0 shipped, but reorganising that header is out of scope for this docs sweep.

@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.

Sorry @robotrocketscience, you have reached your weekly rate limit of 500000 diff characters.

Please try again later or upgrade to continue using Sourcery

@robotrocketscience robotrocketscience added the attn:review Needs review (PR open, awaiting reviewer) label May 14, 2026
@github-actions github-actions Bot added the docs label May 14, 2026
@coderabbitai

coderabbitai Bot commented May 14, 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: f4ce77b4-d902-47d7-8953-220da19e02c2

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-791-v3.0.1-sweep

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 author-jojo Authored by parallel session jojo label May 14, 2026
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[claim:review:pascal:2026-05-14T16:37:00Z]

@robotrocketscience

Copy link
Copy Markdown
Owner Author

Reviewed: 3 atomic signed commits, +12/-1, docs-only diff. Verified content against github/main:

CI: all green (pytest 3.12/3.13, secrets-scan, pattern-scan, history-scan, release-docs-check, bench-smoke, typos, all prefix/link checks). Discretion grep on diff: clean. All commits SSH-signed (G). FF on main.

Labeling ready-to-merge.

@robotrocketscience robotrocketscience added ready-to-merge Trigger merge-train: FF main to this PR's head and removed attn:review Needs review (PR open, awaiting reviewer) labels May 14, 2026
@robotrocketscience

Copy link
Copy Markdown
Owner Author

[release:review:pascal:2026-05-14T16:38:46Z]

@github-actions
github-actions Bot merged commit 385b8e3 into main May 14, 2026
27 of 29 checks passed
@github-actions github-actions Bot removed the ready-to-merge Trigger merge-train: FF main to this PR's head label May 14, 2026
@github-actions

Copy link
Copy Markdown

merge-train: merged 385b8e3main via FF push.

@github-actions github-actions Bot mentioned this pull request May 14, 2026
11 tasks
@robotrocketscience
robotrocketscience deleted the docs/issue-791-v3.0.1-sweep branch May 20, 2026 22:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author-jojo Authored by parallel session jojo docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs sweep for v3.0.1

1 participant