Skip to content

docs: pre-release polish for 1.16.0 — release-body links and README currency - #52

Merged
craigmcchesney merged 2 commits into
mainfrom
docs/pre-release-1.16.0-polish
Sep 16, 2026
Merged

craigmcchesney merged 2 commits into
mainfrom
docs/pre-release-1.16.0-polish

Conversation

@craigmcchesney

Copy link
Copy Markdown
Collaborator

The last documentation blocker before tagging rel-1.16.0. Two independent fixes, one commit each.

1. Release-note links 404 on the release page (9dc0355)

release.yml publishes doc/release-notes/rel-1.16.0.md as the GitHub release body via body_path.
The release page is not served from a path where ../cookbook/ or ../../plan/ resolves, so all
twelve relative links in the notes — correct in the repo — would have 404'd for every reader of
the release itself. Invisible from inside the repository, which is why it survived review of #51.

Rewritten as reference-style links to absolute URLs pinned at rel-1.16.0, so they resolve both in
the repo and on the release page, and the prose stays inside the document's wrap. The fourteen
in-body anchor links are untouched — those resolve against the body and always worked.

Verified: 10 reference definitions, 10 uses, none undefined, none unused, no relative links left,
and every target confirmed present on HEAD (so all will exist at the tag).

2. The README was a release behind (54d0e83)

The 1.16.0 notes linked into documentation that contradicted them:

  • The sample status API was absent entirely — the largest item in this release had no bullet
    under Implemented, no row in the cookbook table, and was not named in the goal-state Annotation row.
  • The cookbook table listed 5 of 7 recipes, omitting both that this release added.
  • Two stale version claims still called the v2 query API "unreleased dp-grpc work" that "will not
    work against a rel-1.14.0 server." Replaced with which server each API actually needs.
  • The TODO listed CI and release publishing as outstanding. Both workflows exist and are green;
    only the PyPI job remains, wired up but deliberately disabled.
  • doc/cookbook/README.md documented the "Verified against" convention that d3024be removed
    from all seven recipes in docs: add the 1.16.0 release notes #51 — my omission there, fixed here.

Also adds the grpcio>=1.84.0 floor to Installation: pip install picks it up, but an existing
editable install does not upgrade on its own and the stubs then fail at import — exactly how it
presented in this repo's own venv during the #51 review.

Every API name added to the README was verified against the source.

Verification

  • 725 unit tests pass, 45 subtests
  • ruff check / ruff format --check clean
  • 107 cookbook snippets type-check
  • every action still SHA-pinned
  • release.yml's pre-build notes gate passes for rel-1.16.0

No code changes.

🤖 Generated with Claude Code

https://claude.ai/code/session_0151QFCHYMNBgEVNGLTgsoFL

craigmcchesney and others added 2 commits September 16, 2026 11:39
…ease body

release.yml publishes doc/release-notes/rel-1.16.0.md as the GitHub release
body via body_path.  The release page is not served from a path where
`../cookbook/` or `../../plan/` means anything, so all twelve relative links
resolved correctly in the repo and 404'd for anyone reading the release.

Rewritten as reference-style links to absolute URLs pinned at the tag, so they
work in both places and the prose stays within the file's wrap.  The fourteen
in-body anchor links are unchanged -- those resolve against the body itself.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0151QFCHYMNBgEVNGLTgsoFL
The README was a release behind, so the 1.16.0 notes linked into documentation
that contradicted them:

- The sample status API -- the largest item in this release -- was absent
  entirely: no bullet under Implemented, no row in the cookbook table, and not
  named in the goal-state Annotation row.
- The cookbook table listed five of the seven recipes, omitting both that this
  release added (sample-status.md, datasets-and-annotations.md).
- Two notes still called the v2 query API "unreleased dp-grpc work" that "will
  not work against a rel-1.14.0 server"; rel-1.15.0 and rel-1.16.0 are tagged.
  Replaced with the durable statement of which server each API needs.
- The TODO listed CI and release artifact publishing as outstanding.  Both
  workflows exist and are green; only the PyPI job remains, and it is wired up
  but deliberately disabled.
- doc/cookbook/README.md still documented the per-recipe "Verified against"
  header convention that d3024be removed from all seven recipes.

Also adds the grpcio>=1.84.0 floor to Installation.  pip install picks it up,
but an existing editable install does not upgrade on its own and the stubs then
fail at import -- which is exactly how it presented in this repo's own venv.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0151QFCHYMNBgEVNGLTgsoFL
Copilot AI lite review requested due to automatic review settings September 16, 2026 17:40

Copilot AI 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.

🟢 Approval recommended

No unresolved blocking issues were identified in the supplied review.

Pull request overview

Polishes 1.16.0 release documentation, fixing release-page links and updating README/cookbook guidance.

Changes:

  • Replaced relative release-note links with tag-pinned absolute references.
  • Updated API, compatibility, dependency, recipe, and release-process documentation.
  • Refreshed cookbook version conventions.
File summaries
File Description
README.md Updates current APIs, recipes, compatibility, and installation guidance.
doc/release-notes/rel-1.16.0.md Fixes release-body links.
doc/cookbook/README.md Updates recipe version conventions.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@craigmcchesney
craigmcchesney merged commit 17d2cdb into main Sep 16, 2026
7 checks passed
@craigmcchesney
craigmcchesney deleted the docs/pre-release-1.16.0-polish branch September 16, 2026 17:57
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.

2 participants