Repository navigation
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| mdformat --check docs/ | ||
| codespell docs/ | ||
| python3 scripts/check_example_refs.py | ||
| zensical build --clean |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
/ai verdict accepted
Can probably remove this part. Anyone making changes to the docs repo should be running these checks already. If they do not run them, then the docs repo CI should run it and flag formatting violations.
There was a problem hiding this comment.
Recorded accepted for AI finding arf_v1_oaz244gk7us4cen5orsqixp6af.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
The mdformat, codespell, check_example_refs, and zensical commands belong to aws/aws-durable-execution-docs. That repository documents them in its CONTRIBUTING.md and runs them in CI. So the release guide does not need to restate them.
d781ef8 to
e00bbd6
Compare
Codex AI reviewNo actionable findings in the documentation-only diff. The prior external-validation concern is resolved. SDK invariants and contract tests are unchanged. Review was read-only; the external documentation workflow was not exercised. Reviewed commit |
Closes #1116
Description of changes
Adds a
### 3. Update the shared documentationstep toRELEASING.mdunder "Cutting a Release", and an "After publishing a release" checklist item. The step assigns the review of aws/aws-durable-execution-docs to the release engineer for every release, covers API references, guides,examples/typescript/snippets, dependency versions, compatibility and migration text (not only version strings), gives a search command and the docs repo's checks, and asks the engineer to open or update the docs PR, link the release, and record "no changes needed" when applicable. Wording mirrors the existing section 4 of the Java SDKRELEASE.md.Docs-only change; no code or CI changes. Sibling PRs: aws-durable-execution-sdk-python #878, aws-durable-execution-sdk-java #843.