Update Changelog
Use this skill to keepchangelog.mdx accurate, concise, and consistent with the portfolio’s existing Mintlify <Update> entries.
Workflow
- Read
changelog.mdxbefore editing. - Identify the month for the change from the current date or the user’s requested release date.
- If an
<Update>block for that month exists:- Add concise bullets to the end of the most relevant subsection.
- Categorize new pages, dedicated sections, or documented tools under
### New content. - Categorize refactors, UI tweaks, or site-wide enhancements under
### Improvements. - Update the introductory paragraph (immediately below the
<Update>tag) to summarize the month’s major themes and link to key new pages. - Update the
<Update>block’sdescriptionattribute to reflect the latest summary theme.
- If the month does not exist, add a new
<Update>block above older entries with:labelasMonth YYYY.descriptionas a short phrase summarizing the theme.- An introductory paragraph summarizing the month’s major themes.
- Subsections in the order:
### New content,### Improvements,### Bug fixes.
- Prefer linking to changed pages with site-relative links, such as
[Posts](/posts)or[Tech Writing Skills](/awesome-tech-writing-skills). - Keep changelog bullets outcome-focused. Mention what changed and why it matters to readers.
- Do not list internal implementation details or meta-updates about the changelog/skill maintenance itself.
- Run
mintlify broken-linksafter editing when available.
Style
- Use sentence-style bullets.
- Keep bullets specific but brief.
- Group related changes into one bullet when the separate details are not user-visible.
- Preserve existing
<Update>ordering, indentation, and MDX component style. - Do not create a changelog entry for trivial copy edits or meta-process changes (like “Updated changelog”) unless the user explicitly asks.