# Changelog overview

EvoHub Changelog publishes your release notes as a changelog site on your own domain, with an embeddable "What's new" widget, feeds and email updates for your users. You write entries in Markdown in the EvoHub console and publish them when they are ready.

The Changelog console lives at [https://evohub.io/changelog-admin](https://evohub.io/changelog-admin).

## Concepts

| Concept | What it is |
| --- | --- |
| **Changelog** | One changelog site: its name, logo, brand colour, domain and settings. An organization can have several, for example one per product. |
| **Entry** | One release note: title, summary, Markdown body, version, categories, tags, date and cover image. |
| **Category** | A coloured label such as **New**, **Improved**, **Fixed** or **Security**. Readers can filter by category. |
| **Subscriber** | An email address that follows the changelog, after confirming. |

A changelog can belong to the whole organization or to one team. A team's changelog is visible only to that team and to organization Admins and Owners.

## Who can do what

Changelogs have no members or roles of their own. What you can do on every changelog of your organization comes from your organization role:

| Permission | Lets you |
| --- | --- |
| `changelog:site:read` | Open changelogs, entries, drafts, feedback and analytics. |
| `changelog:entry:write` | Write and edit entries, upload images, submit drafts for review, import GitHub releases. |
| `changelog:entry:publish` | Publish, schedule and unpublish entries; approve or request changes. |
| `changelog:site:write` | Create changelogs and manage their settings: brand, categories, domain, widget, subscribers, integrations, review, access. |
| `changelog:site:delete` | Delete a whole changelog. |

Members have everything except deleting a changelog; Viewers can read. Deleting a changelog is for Admins. To split the work, build a custom role from the **Changelog writer**, **Changelog reviewer** or **Manages changelogs** presets. See [Roles and permissions](https://docs-dev.evohub.io/roles-and-permissions.md).

## Create a changelog

:::steps
### Open Changelog
In the EvoHub console, open **Changelog**. **Changelogs** lists every changelog you can reach.

### Create it
Choose **New changelog**, enter a **Name** and a **Slug**, and select **Create changelog**. The slug is a short identifier (3–63 lowercase letters, digits and hyphens) that is unique across EvoHub. It names the changelog in the console; it is not a web address. Every new changelog starts with four categories: **New**, **Improved**, **Fixed** and **Security**.

### Brand it
In **Settings**, **Brand**, upload a logo (PNG, JPEG or WebP, up to 2 MB) and pick the brand colour. In **Settings**, **General**, set the description, a **Website** the logo links to, and the **Default theme** (follow the visitor's device, light or dark).

### Write entries
Choose **New entry**. See [Writing entries](https://docs-dev.evohub.io/writing-entries.md).

### Connect a domain
A changelog answers only on its own domain. Connect one in **Settings**, **Domain**. See [Changelog settings](https://docs-dev.evohub.io/changelog-settings.md#custom-domain).

### Publish the changelog
In **Settings**, **General**, choose **Publish changelog**. Until then, nobody outside your organization can see it, and published entries appear once the changelog goes public.
:::

**Take offline** in the same place makes the changelog private again without deleting anything.

## What readers see

On your domain (for example `https://changelog.example.com`), readers get:

- A timeline of entries, newest first, with pinned entries on top of the first page.
- Filters by category and tag, and search.
- A page per entry, with reactions and a **Send feedback** link when those are on.
- A **Subscribe** button for email updates, when email is set up.
- RSS, Atom and JSON feeds, `llms.txt`, Markdown copies of entries and an MCP server for AI tools.

See [Reaching readers](https://docs-dev.evohub.io/reaching-readers.md).

## The console

Inside a changelog, the menu has:

- **Entries** (the changelog's name) — every entry, filtered by **Drafts**, **In review**, **Scheduled** and **Published**, by category, or by search.
- **Categories** — add, rename, recolour, reorder and delete categories (up to 30 per changelog).
- **Feedback** — comments readers sent about entries.
- **Analytics** — how the changelog is read.
- **Settings** — **General**, **Brand**, **Domain**, **Review**, **Widget**, **Subscribers**, **Integrations**, **Access** and **Analytics**.

## Delete a changelog

**Settings**, **General**, **Delete changelog** removes every entry, uploaded image, category and the custom domain. This cannot be undone. Only Admins (or a custom role with `changelog:site:delete`) can do this.

## Billing

Changelog is billed by usage, not per seat: any number of people can write, and any number can read. See [How billing works](https://docs-dev.evohub.io/how-billing-works.md) for what is metered.

## Related

- [Writing entries](https://docs-dev.evohub.io/writing-entries.md)
- [Reaching readers](https://docs-dev.evohub.io/reaching-readers.md)
- [Changelog settings](https://docs-dev.evohub.io/changelog-settings.md)