Skip to content

docs: re-measure the landing page, and complete the 1.12.0 changelog - #112

Merged
Cipher208 merged 1 commit into
masterfrom
docs/landing-page-v1.12.0
Oct 13, 2026
Merged

Cipher208 merged 1 commit into
masterfrom
docs/landing-page-v1.12.0

Conversation

@Cipher208

Copy link
Copy Markdown
Owner

Что не так

README описывал продукт двух релизной давности — и ничто не сравнивало его с тем справочником, на который он ссылается.

Утверждение README Факт Откуда измерено
«six primitives» 7 (добавлен wake_up) server.PRIMITIVE_TOOLS
«65 tools» 66 _EXPOSURE_SUMMARY живого сервера, get_all_tools()
«57 on the common combo» 59 (agent) resolve_exposure("agent", …)
тир brief распущен 2026-09-07, daily_brief едет на review EXTRA_TIERS
«remaining 8 are admin-tier» 7 operator минус agent

docs/index.md отстал сильнее: версия 1.8.1, 927 тестов, 6/46/56 тулов, 23 таблицы.

Что сделано

Каждое число перемерено по коду, а не скопировано из соседнего документа:
resolve_exposure для тиров, свежая мигрированная база для схемы (41 таблица, 57 объектов с 16 тенями FTS5), ключи hooks.user/hooks.agent для хуков.

Одно значение аудит почти испортил. «19 names» в строке хуков — верное (12 слотов user + 13 agent). Рядом стоящее «11» из KNOWN_EVENTS — это внешний мост событий, другая поверхность. Два верных числа про две разные вещи; подмена одного другим была бы дефектом самого аудита. Записано в CHANGELOG, чтобы следующий ревизор не повторил.

Проверено также pyproject.toml («5 primitives») и mcp_server/annotations.py («all 65 tools»).

В changelog не хватало пяти влитых записей

#98, #99, #100, #101, #102 — пара forget (dry run + undo из shadow bin) и три починки shared-соединения. Они были в черновике релиза, но не в CHANGELOG.md, а тело публикуемого релиза берётся из changelog. Значит v1.12.0 объявил бы меньше, чем в нём есть. Записи написаны по коммитам, не по заголовкам.

Два раздела ### Added внутри [1.12.0] сведены в один — страница релиза читается как Added / Fixed / Documentation, а не Added / Fixed / Added / Documentation. Сведение сделано скриптом с проверкой, что набор записей не изменился (16 → 16).

Гейты

  • полная сюита: 2262 passed
  • ruff check / ruff format --check (687 файлов) / mypy (202 файла) — чисто
  • tests/test_code_policy.py — 112 passed
  • uv.lock поднят вместе с версией: первый заход на коммит упал именно на locked-гейте, что и правильно

Тело релиза извлечено тем же регексом, что и в release.yml, до тега: 29 240 знаков, три раздела, шестнадцать записей. test_release_hygiene.py теперь проверяет 1.12.0 против словаря персон — секция впервые вышла из [Unreleased], и проверка прошла.

Что дальше

После мержа — тег v1.12.0: release.yml соберёт пакет, опубликует на PyPI до объявления релиза и создаст GitHub Release с телом из CHANGELOG.

Отмечу расхождение с прошлым релизом: там бамп был отдельным коммитом chore(release): 1.11.1 (#96). Здесь всё в одном PR, чтобы не гонять CI дважды. Скажи, если хочешь разделять — вернусь к этому порядку.

The README described a product two releases old, and nothing compared it to the
reference it points at.

README.md claimed six primitives, 65 tools, a 57-tool combo and a `brief` tier.
Measured from the code: `wake_up` made the primitives **seven**, the full surface
is **66**, the `agent` preset resolves to **59**, and `brief` was dissolved on
2026-09-07 (`daily_brief` rides `review`). `docs/index.md` was further behind —
version 1.8.1, 927 tests, a 6/46/56 surface, 23 DB tables. It now states 1.12.0,
2262 tests, 7/59/66, and 41 tables (57 objects counting the 16 FTS5 shadows),
each number taken from `resolve_exposure`, a freshly migrated database, and the
`hooks.user`/`hooks.agent` config keys rather than from a neighbouring document.

Every count was re-derived, and one of them is worth recording because the audit
nearly broke a correct value: the "19 names" in the hooks row is **right** (12
user + 13 agent slots). The 11 from `KNOWN_EVENTS` counts the external event
bridge — two true numbers about two different surfaces.

`pyproject.toml` and `mcp_server/annotations.py` carried the same stale counts
("5 primitives", "all 65 tools"); both now say seven and 66.

The changelog was missing five merged entries: #98 and #100 (the `forget` dry run
and the undo that restores from the shadow bin) and #99, #101, #102 (the
shared-connection commit repairs). They were in the release draft but not in
CHANGELOG.md, and the published release body is taken *from* the changelog — so
v1.12.0 would have announced a smaller change than it shipped. The two `### Added`
sections inside [1.12.0] are merged into one, so the release page reads Added /
Fixed / Documentation instead of Added / Fixed / Added / Documentation.

Version bumped to 1.12.0 to match the section the release workflow extracts, and
`uv.lock` with it: the locked install gate refuses a commit where the lockfile and
`pyproject.toml` disagree, which is how the first attempt at this commit failed.

Gates: full suite 2262 passed; `ruff check`, `ruff format --check` and `mypy`
(202 files) clean; `tests/test_code_policy.py` 112 passed. The release body was
extracted with the workflow's own regex before tagging: 29,240 characters, three
sections, sixteen entries, and `test_release_hygiene.py` now checks 1.12.0 against
the persona dictionary because the section left `[Unreleased]`.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 13, 2026
@coderabbitai

coderabbitai Bot commented Oct 13, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Repository: Cipher208/a-memory/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 85b066f6-3519-4514-b8f2-832438515fcd
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@Cipher208
Cipher208 merged commit ce3be89 into master Oct 13, 2026
19 checks passed
@Cipher208
Cipher208 deleted the docs/landing-page-v1.12.0 branch October 13, 2026 04:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant