Templates / Release Notes

Release Notes PDF template — render it from Markdown

Release notes are the changelog dressed for customers. Roboto Mono version headings give each release a firm timestamped anchor, a vivid violet accent flags what's new, and boxed code blocks on US Letter carry migration snippets — engineering truth, presented like you meant it.

Release Notes
Before & after

Plain Markdown in. A release notes worth sending out.

You already write the changelog in Markdown; this template makes it shippable. Pipe CHANGELOG.md — or the release section your agent drafts from merged PRs — through one render call in the release pipeline, and every version ships with a matching PDF for the customers who file these things.

release-notes.mdMD
# Northwind Platform — Release 2.14

**Released** July 2, 2026 · **Channel** Stable

## Highlights

- **Usage-based billing (beta)** — meter renders per workspace
  with a customer-set spend cap
- **Notification center** — unified read-state across web and
  mobile, per-category mutes

## Improvements

- Job queue p95 latency down 38% under sustained load
- CSV export now streams; 1M-row exports no longer time out
- Audit log filters by actor, action and date range

## Fixes

- Fixed a race where a cancelled job could report success
- Webhook retries now honor `Retry-After` on 429 responses
- Timezone handling corrected for scheduled reports (DST)

## Breaking changes

`GET /v2/reports` now paginates by cursor. Offset pagination
is removed. Migrate:

```diff
- GET /v2/reports?offset=200&limit=100
+ GET /v2/reports?cursor=eyJpZCI6...&limit=100
```

## Deprecations

- `priority: "urgent"` on job creation — use `high`; removal
  in 2.16.
release-notes.pdfPDF
Release Notes
Render it your way

Three ways to render the release notes.

Dashboard

Paste your Markdown in the editor, pick Release Notes, and download the PDF — no code involved.

REST API
curl https://inkrun.dev/api/v1/render \
  -H "Authorization: Bearer sk_..." \
  -H "Accept: application/pdf" \
  -d '{"template": "release-notes", "markdown": "# ..."}' \
  --output release-notes.pdf
MCP · your agent

Add the Inkrun MCP connector once, then ask your agent:

Draft release notes from these merged PRs and render them with the release-notes template.
FAQ

Release Notes template — common questions.

Can release notes render automatically on each release?

Yes — add one API call to your release pipeline that sends the changelog section; the PDF becomes a build artifact like any other.

How are breaking changes and diffs displayed?

Fenced code and diff blocks render boxed in monospace, so migration snippets stand out from the prose.

Can an agent write the notes from merged PRs?

That's the ideal setup — an MCP-connected agent summarizes the PRs and calls Inkrun with the release-notes template in one step.

Related templates

If you render release notess, you probably ship these too.

API Reference
API Reference

Roboto Mono headings and grid tables for endpoint docs.

A4Roboto Mono headInter body
Explore this template
Section
Product Brief
Product Brief

Crisp Inter with a confident indigo — lots of breathing room.

A4Inter headInter body
Explore this template
Runbook
Runbook

Operational runbook in a calm teal with monospace headings.

A4Mono headRoboto body
Explore this template
Inkrun © 2026