PluginBench
Skill
Pass
Audit score 90

release-notes-one-pager

nexu-io/open-design

Generate a single-page HTML release notes document with highlights, changes, and upgrade guidance.

What is release-notes-one-pager?

Creates a formatted one-page HTML release notes document covering version highlights, additions, fixes, breaking changes, known issues, and upgrade steps. Use this when you need to communicate release information in a clean, scannable format with consistent structure and styling.

  • Generates single-page HTML release notes with standard sections (Added, Fixed, Breaking changes, Known issues, Upgrade note)
  • Includes navigation links to jump between sections
  • Applies design system colors, typography, and layout components automatically
  • Writes explicit "None" or "No X provided" placeholders for missing details instead of leaving gaps
  • Provides hero section with version, date, and summary
  • Includes closing CTA strip for additional actions or links

How to install release-notes-one-pager

npx skills add https://github.com/nexu-io/open-design --skill release-notes-one-pager
Prerequisites
  • Access to project DESIGN.md for design system variables (color, typography, layout, components)
  • Release information: version number, date, and details for each section
Claude Code
Cursor
Windsurf
Cline

How to use release-notes-one-pager

  1. 1.Read the template.html seed file from assets/
  2. 2.Review layouts.md for section structure options
  3. 3.Map your project's DESIGN.md to the six :root CSS variables
  4. 4.Copy assets/template.html to your project as index.html
  5. 5.Update title, navigation labels, and CTA destinations with real values
  6. 6.Fill in release content in order: Hero, Added, Fixed, Breaking changes, Known issues, Upgrade note
  7. 7.Ensure all section root elements have matching id attributes for navigation links
  8. 8.Run the checklist.md to verify all P0 requirements pass

Use cases

Good for
  • Publishing release notes for a software version update to stakeholders
  • Creating a changelog document that's easy to scan and navigate
  • Communicating breaking changes and upgrade requirements to users
  • Documenting new features and bug fixes in a structured format
  • Generating release summaries for internal or external distribution
Who it's for
  • Engineering teams releasing software versions
  • Product managers communicating changes to users
  • DevOps engineers documenting deployment updates
  • Open-source project maintainers publishing releases

release-notes-one-pager FAQ

What if I don't have all the release information?

Write explicit placeholders like "No additions provided" or "None" for missing sections. Do not invent details or leave sections empty.

Can I customize the HTML structure or CSS?

Use the provided template and layouts unless you explicitly need a bespoke structure. The skill is designed to work with the seed file and design system mapping.

What should I do with CTA links if I don't have real destinations?

Omit the CTA entirely rather than using placeholder hrefs like "#" or misleading anchors. Only include CTAs with real, safe destinations.

How do I ensure the navigation links work?

Add matching id attributes to each section root element (e.g., id="added", id="fixed", id="upgrade-note") so the topnav links can anchor to them.

What if my design system has different variables?

Map your DESIGN.md sections (color, typography, layout, components) to the six :root variables in the template before building the release notes.

Full instructions (SKILL.md)

Source of truth, from nexu-io/open-design.


name: release-notes-one-pager description: | Release notes one-page HTML with highlights, Added, Fixed, Breaking changes, Known issues, and Upgrade note. Writes explicit "None" style sections whenever the user does not provide details. triggers:

  • "release notes"
  • "changelog"
  • "what's new"
  • "version update"
  • "change log"
  • "release summary" od: mode: prototype platform: desktop scenario: engineering preview: type: html entry: index.html design_system: requires: true sections: [color, typography, layout, components] example_prompt: "Write release notes for v2.3.1 with Added, Fixed, Breaking changes, Known issues, and an Upgrade note."

Release Notes One-Pager Skill

Produce a single-page release notes document in HTML.

Resource map

release-notes-one-pager/
├── SKILL.md                    ← this file
├── example.html                ← quality bar and style reference
├── assets/
│   └── template.html           ← local seed file to copy to project index.html
└── references/
    ├── checklist.md            ← P0 / P1 / P2 gates
    └── layouts.md              ← local section skeletons

Do not write CSS from scratch unless the user explicitly asks for a bespoke structure.

Workflow

Step 0 — Pre-flight

  1. Read assets/template.html.
  2. Read references/layouts.md.
  3. Read active DESIGN.md and map it to the six :root variables.

Step 1 — Start from the shared seed

Copy assets/template.html to project index.html.

Update:

  • <title>
  • topnav logo text
  • topnav link labels (destinations are pre-wired to #added, #fixed, #upgrade-note)
  • topnav CTA label and href destination, or omit the topnav CTA entirely if no real destination exists
  • ensure the topnav link targets exist by adding matching section id attributes

Step 2 — Build release-note structure

Inside <main id="content">, compose this section order:

  1. Hero (Layout 1 or 2): version, date, one-sentence summary.
  2. Added (use Layout 7 log-list; section root must include id="added").
  3. Fixed (use Layout 7 log-list; section root must include id="fixed").
  4. Breaking changes (use Layout 7 log-list, or one row explicitly saying "None"; section root must include id="breaking-changes").
  5. Known issues (Layout 7 or card list; section root must include id="known-issues").
  6. Upgrade note (short steps list or explicit no-action statement; section root must include id="upgrade-note").
  7. Closing CTA strip (Layout 6).

For every CTA in the emitted HTML (topnav, hero, closing strip), replace both the visible label and the href destination with real, safe values. If no real destination is available, omit the CTA entirely—do not use a placeholder such as href="#", a misleading page-anchor, or REPLACE_WITH_REAL_URL. Hero CTAs are optional; only add them when real destinations exist.

Step 3 — Honesty rules for missing details

If the user does not provide details, do not invent them. Write explicit placeholders:

  • Summary: No summary provided.
  • Added: No additions provided
  • Fixed: No fixes provided
  • Breaking changes: None
  • Known issues: None reported
  • Upgrade note: No upgrade actions required based on provided information

If release version or date is missing, use and label the field rather than guessing.

Step 4 — Self-check

Run references/checklist.md. Every P0 must pass.

Step 5 — Emit artifact

Wrap output as:

<artifact identifier="release-notes-one-pager" type="text/html" title="Release Notes">
<!doctype html>
<html>...</html>
</artifact>

One sentence before the artifact. Nothing after </artifact>.