LearnNewsExamplesServices
Frontmatter
id12733
titleAdd curated v13 changelog digest section
stateClosed
labels
documentationenhancementai
assigneesneo-gpt
createdAtJun 8, 2026, 6:20 AM
updatedAtJun 8, 2026, 10:58 AM
githubUrlhttps://github.com/neomjs/neo/issues/12733
authorneo-gpt
commentsCount4
parentIssue12696
subIssues[]
subIssuesCompleted0
subIssuesTotal0
blockedBy[]
blocking[]
closedAtJun 8, 2026, 10:58 AM

Add curated v13 changelog digest section

Closed v13.0.0/archive-v13-0-0-chunk-17 documentationenhancementai
neo-gpt
neo-gpt commented on Jun 8, 2026, 6:20 AM

Context

v13 release-note work is intentionally iterative under #12696. The current resources/content/release-notes/v13.0.0.md has strong narrative chapters, but the benchmark release notes named by the operator - resources/content/release-notes/chunk-2/v12.1.0.md and resources/content/release-notes/chunk-2/v11.24.0.md - both include a reader-facing Full Changelog section with curated categories and representative issue/PR bullets.

V-B-A evidence collected on 2026-06-08:

  • wc -l -w shows current v13 at 380 lines / 4,877 words; v12.1 at 459 lines / 5,116 words; v11.24 at 264 lines / 2,091 words. The problem is not length alone.
  • Heading scan shows v13 ends with ## Full Changelog Strategy, while v12.1 and v11.24 both contain concrete ## Full Changelog sections with category headings and representative bullets.
  • Discussion #12694 resolves the boundary: use curated narrative sections plus reproducible/generated appendices for the exhaustive 1,200+ PR / 1,600+ issue scale; do not dump every PR/issue into the narrative body.
  • Live latest-open sweep: checked latest 20 open issues at 2026-06-08 during ticket creation; no equivalent issue found. Nearby release-note tickets are #12723 (appendix evidence), #12725 (scale proof), and #12729 (upgrade path), but none owns the curated changelog digest.
  • Semantic ticket sweep via ask_knowledge_base(query='existing ticket for v13 release notes curated changelog digest full changelog appendix', type='ticket') found historical release-note tickets (#9574, #9346) and no existing v13 changelog-digest ticket.
  • Exact local sweep for curated changelog|Full Changelog|changelog digest|release notes.*digest|v13.*changelog found Discussion #12694 and issue #11594 reference hygiene only; no active implementation ticket.

The Problem

The v13 note currently explains why exhaustive lists belong in generated appendices, but it does not yet provide the reader-facing changelog digest that earlier high-quality release notes provide.

That creates two failures:

  1. Human readers lose the scan-friendly proof layer between narrative chapters and exhaustive generated data.
  2. The release-note artifact undersells the breadth of v13 because the shipped categories are not summarized in a concrete changelog-style section.

The fix must respect the v13 scale. A raw list of 1,200+ PRs is unreadable and contradicts Discussion #12694. The missing layer is a curated digest: enough categorized bullets to prove scope, not an exhaustive corpus dump.

The Architectural Reality

Release notes are public documentation and ingestion substrate. They are read by humans, the docs/SEO pipeline, Knowledge Base ingestion, and future release-workflow agents.

Relevant current surfaces:

  • resources/content/release-notes/v13.0.0.md - current v13 release artifact.
  • resources/content/release-notes/chunk-2/v12.1.0.md - benchmark with phased narrative plus categorized Full Changelog.
  • resources/content/release-notes/chunk-2/v11.24.0.md - benchmark with concise categorized Full Changelog.
  • Discussion #12694 - source of authority for curated narrative + generated appendices boundary.
  • #12696 - parent v13 release epic.

The Fix

Add a curated Full Changelog / Changelog Digest section to the v13 release notes after the narrative body and before or near the existing generated-appendix strategy.

The digest should:

  • Use category headings comparable to v12.1/v11.24, adapted to v13's actual scope: Agent OS / Memory Core, Native Edge Graph / Dream Pipeline, Swarm Governance, GitHub Workflow / Plan Surface, Multi-Tenant Deployment, AiConfig / Config Substrate, Body / Grid / UI, External Providers / Build, Docs / Identity, Reliability / Tests.
  • Include representative high-signal bullets with issue/PR references, not every item.
  • Preserve the generated appendix strategy for exhaustive PR/issue tables.
  • Refresh the release-window counts immediately before final release cut or clearly mark them as pre-cut evidence.
  • Avoid over-claiming grid completion while #9491, #9872, and #9492 remain open.

Contract Ledger Matrix

Target Surface Source of Authority Proposed Behavior Fallback Docs Evidence
resources/content/release-notes/v13.0.0.md changelog section v12.1/v11.24 release-note precedent + Discussion #12694 Add a curated changelog digest with category headings and representative bullets If counts or generated data are stale, keep the digest qualitative and retain appendix-generation instructions Same file Heading scan + release-note build verification
Exhaustive v13 PR/issue corpus Discussion #12694 + existing Full Changelog Strategy section Keep exhaustive lists in generated appendices or reproducible queries, not the narrative body Link to generation command and refresh checklist Same file Release appendix script or final pre-cut count check
Body/Grid release boundary #9491, #9872, #9492, #12708 Mention landed SortZone evidence without claiming final multi-body grid architecture complete Defer final grid wording until grid tickets land Same file Live issue/PR state before release cut

Decision Record impact

none.

Acceptance Criteria

  • v13 release notes contain a concrete curated changelog digest section, not only Full Changelog Strategy prose.
  • Digest categories are adapted to v13 scope and include representative high-signal issue/PR bullets.
  • Exhaustive 1,200+ PR / 1,600+ issue data remains in generated appendices or reproducible queries, not dumped into the narrative body.
  • Section structure is compared against v12.1.0.md and v11.24.0.md before PR open.
  • Release-note build/index generation is run after the edit.
  • Body/Grid wording stays honest about #9491, #9872, and #9492 until those tickets are terminal.

Out of Scope

  • Final narrative-arc rewrite of the whole v13 artifact.
  • Authoring the future release-notes skill; #10321 remains parked until after v13 lands.
  • Generating or committing an exhaustive 1,200+ PR appendix inside the narrative body.
  • Claiming the multi-body grid architecture is complete before #9491, #9872, and #9492 land.

Avoided Traps / Gold Standards Rejected

  • Reject raw mega-changelog in the narrative body: it contradicts Discussion #12694 and would bury the story under scale.
  • Reject only keeping Full Changelog Strategy: it explains process but does not give readers the concrete scan layer v12.1/v11.24 provide.
  • Reject final-polish-only framing: this is content coverage, not just prose polish.

Related

Origin Session ID: e8f07ef9-ef7e-4815-8ff4-7abe13720621

Handoff Retrieval Hints: query_raw_memories("v13 release notes curated changelog digest v12.1 v11.24 Full Changelog"); inspect resources/content/release-notes/v13.0.0.md, resources/content/release-notes/chunk-2/v12.1.0.md, resources/content/release-notes/chunk-2/v11.24.0.md, and Discussion #12694.

tobiu referenced in commit bce7d07 - "docs(release): add v13 changelog digest (#12733) (#12736)" on Jun 8, 2026, 10:58 AM
tobiu closed this issue on Jun 8, 2026, 10:58 AM