fix: move cancellation docs into docs/ so they survive README regeneration#430
Merged
Conversation
…ADME regeneration The cancellation documentation (withCancellationToken option and Cancellation section) was added directly to README.md in PR #420. However, README.md is auto-generated by concatenating docs/0*.md files via generate_all_docs.sh. When the release prep workflow regenerates the README, the cancellation content gets lost because it lives only in README.md itself. Fix: move the content into docs/03_Usage.md (the Usage doc where the options table and transactions section live), then regenerate README.md from the docs.
Contributor
Release Assistant - PassedNo version-worthy changes detected. Only non-functional, doc, or test changes. |
This was referenced Jul 25, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
PR #420 added the
withCancellationTokenoption and cancellation documentation directly toREADME.md. However,README.mdis auto-generated bygenerate_all_docs.shwhich concatenates alldocs/0*.mdfiles. When the release prep workflow (gen-release-pr.yml) regenerates the README, the cancellation content gets lost — as seen in the auto-generated release prep PR #428.Fix
withCancellationTokenrow to the options table indocs/03_Usage.md### Cancellationsection (with code example and notes) todocs/03_Usage.mdafter the Transactions sectionREADME.mdfrom the docs viagenerate_all_docs.shNow when the release prep workflow runs, the cancellation docs will be preserved in the regenerated README.
Verification
Ran
./docs/scripts/generate_all_docs.shlocally and verified the cancellation content appears in the regenerated README at the expected location (between Transactions and PostgreSQL sections).