Skip to content

docs(release): shorten four notes to the release-note cap - #1194

Closed
ragnorc wants to merge 1 commit into
ModernRelay:mainfrom
ragnorc:docs/release-note-caps
Closed

ragnorc wants to merge 1 commit into
ModernRelay:mainfrom
ragnorc:docs/release-note-caps

Conversation

@ragnorc

@ragnorc ragnorc commented Oct 28, 2026

Copy link
Copy Markdown
Contributor

The documentation check on main fails since #1150 merged. #880 caps a release note at 200 characters of visible text (400 for a breaking note) for every note added since v0.14.0. Four notes added after #880 are longer: index-build-command.added.md (496), ensure-indices-refreshes-coverage.changed.md (283) and full-text-remedies-parse.fixed.md (277) from #1150, and nix-flake.added.md (255) from #1153. The check reports only the first, so every pull request currently fails "Check AGENTS.md Links" on main's notes.

This shortens those four notes in place, with the same categories and links. Each keeps its user-visible facts. The index build note drops the optimize and ensure_indices_on_as sentences, which the ensure-indices note and the maintenance guide's Build indexes section already carry. The full-text remedies note drops "every such remedy is checked to parse", which is a test, not behavior. The Nix note drops "with the release archives' toolchain, packages and features", which the install guide states.

All 24 notes added since v0.14.0 now pass the note cap check. The documentation check passes on this branch and fails on f76d6011 with the 283-character error. The working-tree release preview now renders; on main it stops at the same note.

For review: ensure-indices-refreshes-coverage stays a .changed note, as #1150 filed it. With a policy installed, ensure_indices and ensure_indices_on now refuse without an actor, so an embedded host that relied on them bypassing the policy gate has to change its call. A reviewer may prefer that fact as a .breaking note with a link to upgrade steps; this pull request does not decide that.

ModernRelay#880 caps a note at 200 characters of visible text, but four notes added
after it in this cycle are longer, so the documentation check fails on main:
the three from the index build command and the Nix flake note. Each keeps its
facts; details stay in the guides the notes link.
@ragnorc
ragnorc enabled auto-merge October 28, 2026 20:26
@ragnorc
ragnorc added this pull request to the merge queue Oct 28, 2026
@github-merge-queue
github-merge-queue Bot removed this pull request from the merge queue due to a conflict with the base branch Oct 28, 2026
@ragnorc

ragnorc commented Oct 28, 2026

Copy link
Copy Markdown
Contributor Author

Superseded by #1193, which shortened the same four notes and merged first.

@ragnorc ragnorc closed this Oct 28, 2026
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