Changelog

The changelog lets you announce documentation updates to your readers. Each entry has a title, content body, optional version tag, and a draft/published state. Published entries are visible on your public changelog page and available via RSS.

Creating an entry

From your project dashboard, go to the Changelog tab and click New Entry.

Each entry accepts:

You can also create entries via the API:

curl -X POST https://app.skrypt.sh/api/projects/{slug}/changelog \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Added authentication guide",
    "content": "New step-by-step guide covering OAuth2 and API key auth.",
    "version": "v2.1.0",
    "is_draft": false
  }'

Setting is_draft to false publishes the entry immediately and sets published_at to the current timestamp.

Draft vs published

Entries start as drafts by default. Drafts are only visible to the project owner in the dashboard.

To publish a draft, update it with is_draft: false:

curl -X PATCH https://app.skrypt.sh/api/projects/{slug}/changelog \
  -H "Content-Type: application/json" \
  -d '{
    "id": "entry-uuid",
    "is_draft": false
  }'

When an entry transitions from draft to published, Skrypt automatically sets the published_at timestamp. You can override this by passing a custom published_at value.

Published entries appear in reverse chronological order (newest first) on the public changelog page and in the RSS feed.

Updating entries

Update any field on an existing entry:

curl -X PATCH https://app.skrypt.sh/api/projects/{slug}/changelog \
  -H "Content-Type: application/json" \
  -d '{
    "id": "entry-uuid",
    "title": "Updated title",
    "content": "Revised description.",
    "version": "v2.1.1"
  }'

Only the fields you include are updated. Omitted fields stay unchanged.

Deleting entries

Delete an entry by ID:

curl -X DELETE "https://app.skrypt.sh/api/projects/{slug}/changelog?id={entry-uuid}"

This permanently removes the entry. Deleted entries cannot be recovered.

RSS feed

Every project has an auto-generated RSS feed at:

https://app.skrypt.sh/api/projects/{slug}/changelog/rss

The feed includes the 50 most recent published entries. Each item contains the title, version (if set), a truncated description (500 characters), and the publication date.

The feed is publicly accessible with no authentication required. It returns application/rss+xml with a 5-minute cache TTL.

Use the RSS URL to subscribe in any feed reader, or integrate it with tools like Slack RSS or Zapier.

Public changelog page

Readers can view published changelog entries at your project's changelog page in the dashboard:

https://app.skrypt.sh/dashboard/{slug}/changelog

Entries are displayed in reverse chronological order with title, version badge, content, and publication date.

What's next

• Webhooks, notify external services when you deploy
• Branching, draft changes on a branch before publishing
• Getting Started, set up your first project