Skip to content

skills: update changelog skill #4248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devalog merged 1 commit into from
Mar 13, 2026
Merged

skills: update changelog skill #4248

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions .claude/skills/changelog/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,10 @@ Pick 1–4 tags that best describe the change. Prefer fewer, more specific tags.
- **Opening line**: Lead with what the user can now do. Start with "You can now..." or a direct statement of the capability.
- **Tone**: Professional, friendly, concise. Focus on user benefit, not implementation details.
- **Length**: Keep entries short — typically 2–6 sentences per feature. Use bullet points for lists of details.
- **"Learn more" link**: End with a link to the relevant docs page using the `/learn/...` URL format (see `AGENTS.md` link rules).
- **"Read the docs" button**: End with a Button component linking to the relevant docs page using the `/learn/...` URL format (see `AGENTS.md` link rules):
```mdx
<Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/section/page">Read the docs</Button>
```
- **Dashboard CTA**: Dashboard entries often include a path to the feature: "To get started, go to **Settings** > **Feature** in the [Dashboard](https://dashboard.buildwithfern.com/)."

## Structure template
Expand All @@ -80,7 +83,7 @@ Optional details:
- Bullet point 1
- Bullet point 2

Learn more about [feature name](/learn/docs/section/page).
<Button intent="none" outlined rightIcon="arrow-right" href="/learn/docs/section/page">Read the docs</Button>
```

### Dashboard entry
Expand All @@ -94,13 +97,16 @@ tags: ["relevant-tag"]

One or two sentences explaining what users can now do.

[Learn more](/learn/dashboard/section/page) about feature name. To get started, go to **Menu** > **Option** in the [Dashboard](https://dashboard.buildwithfern.com/).
To get started, go to **Menu** > **Option** in the [Dashboard](https://dashboard.buildwithfern.com/).

<Button intent="none" outlined rightIcon="arrow-right" href="/learn/dashboard/section/page">Read the docs</Button>
```

## Components you can use

- `<Frame>` with `<img>` — for screenshots
- `<iframe>` — for embedded content like PDFs
- `<Tabs>` and `<Tab>` — for alternative views
- `<Button>` — for "Read the docs" CTAs
- `<Note>`, `<Warning>` — for callouts
- Code blocks with language and optional `title` — for config examples
Loading