feat: checkin skill for formatting release notes#1860
Conversation
Signed-off-by: Giles Cope <gilescope@gmail.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f0a022a83b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| 3. For SDK / API pages: signature, parameters, return type, examples, error cases. | ||
| 4. For config guides: each new flag/env var, default, when to set it, interaction with existing config. | ||
| 5. For engineering docs: motivation, design alternatives considered, architectural impact, links to relevant code. | ||
| 6. Cross-link back to the release notes file (`../../release-notes-<VERSION>.md`). |
There was a problem hiding this comment.
For any supporting doc written under docs/release-notes/<VERSION>/, this instructed backlink resolves to docs/release-notes-<VERSION>.md, which is not where the release notes are generated later (release-notes-VERSION.md in the repo root) and also does not match the existing version-folder convention. Generated supporting docs will therefore contain broken links back to the main release notes unless this relative path is corrected.
Useful? React with 👍 / 👎.
demarcate arg Co-authored-by: Squirrel <giles.cope@shielded.io> Signed-off-by: Squirrel <giles.cope@shielded.io>
![jina-simulation[bot]](https://avatars.githubusercontent.com/u/97225700?s=60&v=4){kind=small}
Signed-off-by: Squirrel <giles.cope@shielded.io>
1 participant
Overview
Skill for updating release notes. It assumes you're in the released branch checkout dir.