| name | azonpress-changelog |
| description | Add or maintain a release entry in the AzonPress docs changelog (guide/changelog.md). Prepends a new reverse-chronological version section using the site's exact ::: code-group format with ๐ New Features / ๐ง Improvements / ๐๏ธ Removed / ๐ Bug fixes tabs, rewriting raw release notes or git history into user-facing language. USE FOR: write a changelog entry, update the changelog, add release notes, document version X, we shipped a new release. DO NOT USE FOR: writing or updating feature guides (use azonpress-add-doc or azonpress-edit-doc), or site-wide checks (use azonpress-audit-docs). |
| license | MIT |
| compatibility | Operates on guide/changelog.md in the azonpress-docs VitePress site. Uses VitePress ::: code-group containers with md-fenced tabs. Requires Node + npm to run docs:build. |
| metadata | {"project":"azonpress-docs","canonical-rules":"CLAUDE.md"} |
AzonPress Changelog Entry
Add a release to guide/changelog.md, newest first, in the site's established format.
Agent Behavior Rules
- DO read the existing top entry in
guide/changelog.md before writing, and copy its exact
structure โ spacing, emoji, and tab order included.
- DO write from the user's point of view: what changed for someone using the plugin, not
what changed in the code. "Fixed lowercase ASINs not resolving", not "normalize ASIN casing in
ProductResolver::fetch()".
- DO use
โข bullets, sentence case, and no trailing period.
- DO omit any tab that has no entries โ do not ship an empty
๐ Bug fixes block.
- DO insert the new release directly beneath the intro paragraph, above the previous release.
- DO ask for the release date if it isn't given; the format is
*Released on July 21, 2026*.
- DO end on a clean
npm run docs:build.
- DO NOT reorder, reword, or "tidy" past releases โ they are a historical record.
- DO NOT include internal refactors, test changes, dependency bumps, or ticket numbers.
- DO flag it when a release changes documented behavior: if a feature was removed or
reworked, the corresponding guide page probably needs an edit too. Say so in the report โ
the changelog alone is not enough.
Phase 1: Setup (Interactive)
1.1 Source material
What's in this release? (release notes, a git log range, a plugin readme.txt section, or a
plain description)
Record SOURCE.
1.2 Version and date
Version number? and release date?
Record VERSION (e.g. 2.4.0) and DATE (e.g. August 12, 2026).
1.3 Confirm the classification
Sort every item into the four buckets and show the user the draft classification before writing:
๐ New Features - capabilities that did not exist before
๐ง Improvements - existing behavior made better, faster, or clearer
๐๏ธ Removed - features, settings, or fields taken away
๐ Bug fixes - things that were broken and now work
Drop anything users can't perceive. Wait for confirmation.
Phase 2: Context
- Read the top ~45 lines of
guide/changelog.md โ the intro plus the current newest release.
- Note the exact format of the previous entry and mirror it.
- If the release removes or changes a documented feature, grep for it so you can name the
affected guide pages in your report:
grep -rln '<feature term>' --include='*.md' guide
Phase 3: Procedure
1. DRAFT - Rewrite each item into one user-facing line.
Keep lines short โ one clause, no sub-bullets.
2. INSERT - Prepend the new section directly under the intro paragraph
of guide/changelog.md, above the previous release heading.
Use the exact template below. Omit empty tabs.
3. BUILD - npm run docs:build ; confirm the code-group renders and the build is clean.
Template
## AzonPress v<VERSION>
*Released on <DATE>*
::: code-group
```md [๐ New Features]
โข <User-facing capability that is new>
```
```md [๐ง Improvements]
โข <Existing behavior, now better>
```
```md [๐๏ธ Removed]
โข <What was taken away, and ideally why>
```
```md [๐ Bug fixes]
โข <What was broken, phrased as "Fixed ...">
```
:::
Note the fence language inside each tab is md, and the tab label sits in [...] after it.
Phase 4: Verify & Report
Report:
- Version and date added
- Item counts per tab, and which tabs were omitted
- Anything from the source you deliberately dropped as not user-facing
- Guide pages that likely need updating because of this release (name them)
- Build: pass / fail
Quick Reference
House style
Heading: ## AzonPress v2.3.0
Date: *Released on July 21, 2026*
Bullets: โข sentence case, no trailing period
Tabs: ๐ New Features | ๐ง Improvements | ๐๏ธ Removed | ๐ Bug fixes
Order: newest release first, directly under the intro paragraph
Good vs bad entries
GOOD โข Fixed lowercase ASINs not resolving
BAD โข Fix ASIN case normalization in ProductResolver (#412)
GOOD โข Cached product fallback when Amazon is unreachable
BAD โข Added try/catch around the Amazon API client
GOOD โข Prime badges and the Hide Prime status option, no longer sent by Amazon
BAD โข Removed prime_eligible field
Key Principles
- User-facing language only.
- Copy the previous entry's format exactly.
- Empty tabs get omitted, not shipped blank.
- Never rewrite history.
- A removed feature usually means a guide page needs editing too โ say so.