EvoHub Docs Sign in
DeutschDE
EnglishDeutsch
Diese Seite liegt noch nicht auf Deutsch vor und wird auf Englisch angezeigt.

Changelog

Writing entries

Mit KI verwenden
Als Markdown anzeigenDiese Seite als reiner Text, zum Einfügen in ein KI-Tool In Claude öffnenClaude Fragen zu dieser Seite stellen In ChatGPT öffnenChatGPT Fragen zu dieser Seite stellen
Mit Cursor / VS Code / Claude verbindenDiese Dokumentation aus Ihrem KI-Tool durchsuchen und lesen (MCP-Server)

URL des MCP-Servers

https://docs-dev.evohub.io/mcp

Zu Cursor hinzufügenZu VS Code hinzufügen

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai und Claude Desktop): Einstellungen → Konnektoren → Benutzerdefinierten Konnektor hinzufügen und die URL oben einfügen.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

An entry is one release note. You write it as a draft, publish it now or schedule it for later, and readers see the published copy. This page covers the entry editor, categories, the publishing workflow, review and importing from GitHub releases.

Create an entry

In a changelog, choose New entry, give it a Title, and select Create draft. Nothing is public until you publish it.

The entry editor

The body is Markdown, written in the same editor as EvoHub Docs pages: a toolbar, an Insert menu for callouts, tabs, code groups, diagrams and other components, image upload (paste or drop an image into the editor), and a Markdown cheat sheet. See Writing pages for the full syntax.

Beside the body, Details holds:

Field What it does
Summary One or two sentences (up to 300 characters), shown in the list, feeds and link previews.
Version Optional, like v2.4.0.
Categories Up to 5 per entry.
Tags Free-form labels, up to 10 per entry. Readers can filter by tag.
Date shown Optional. Leave it empty to show the publish time.
Author name Leave it empty to show the name of whoever publishes.
Cover image Shown above the entry and in link previews.
Pin to the top Pinned entries stay above the timeline on the first page.
Address The entry's part of the web address, derived from the title.

Images you upload are stored with the changelog: PNG, JPEG, WebP, GIF or SVG, up to 5 MB each.

Warning

Changing the Address of a published entry moves it at once and breaks links people already have.

Save keeps your edits in the draft. If someone else saved the same entry in the meantime, you choose whose version to keep; nothing is overwritten silently.

Categories

Every changelog starts with New, Improved, Fixed and Security. On the Categories page, people who manage the changelog can add categories (up to 30), change names and colours, reorder them, and delete them. Deleting a category removes it from every entry and from subscribers who followed it.

Statuses

Status Meaning
Draft Being written; not public.
In review Submitted for review.
Scheduled Will publish itself at a set time.
Published Live.

A published entry that you edit stays Published: readers keep seeing the live copy, and the editor shows Unpublished changes until you choose Publish changes.

Publish

Anyone with changelog:entry:publish can:

  • Publish now — the draft goes live. The first time, it also sends notifications (below).
  • Schedule… — pick a date and time up to a year ahead. The entry goes live by itself at that time; Unschedule cancels it.
  • Unpublish — takes the entry off the changelog. The draft stays.

Notify subscribers and integrations

When you publish or schedule, Notify subscribers and integrations decides whether the entry is announced: emailed to subscribers (or included in the weekly digest), and posted to Slack and webhooks. Only the first publish of an entry is announced; editing and republishing never sends anything again. See Reaching readers.

Review

In Settings, Review, turn on Entries need approval to go live and set Approvals needed (1 to 3). Then:

  1. A writer saves the draft and chooses Submit for review.
  2. Anyone with changelog:entry:publish reviews it in the editor's Review panel with Approve or Request changes, and an optional comment.
  3. Once the entry has enough current approvals, it can be published or scheduled.

The rules:

  • An approval counts only for the draft it was given on. Any later edit makes earlier approvals stale (they show as Older draft), and the entry needs approving again.
  • The person who edited the draft last cannot approve it.
  • Reviews must come from a person signed in to EvoHub. An API key cannot approve.
  • Nobody publishes around the gate, Admins included. The approvals are checked again when a scheduled entry fires; if they no longer hold, the entry goes back to In review instead of publishing.

Publish history

Every publish is kept in Publish history (the newest 50). View shows an earlier version; Restore copies it into the draft without publishing it.

Import GitHub releases

To start from release notes you already have, open Settings, Integrations, GitHub releases and choose Import releases…:

  1. Enter the Repository as owner/name. Public repositories only.
  2. Choose how many Latest releases to import (1 to 50), and whether to Include pre-releases.
  3. Choose Import.

Each release becomes a draft entry: the title is the release name (or tag), the version is the tag, the date is the release date, and the body is the release notes. Releases you imported before and draft releases are skipped. Nothing is published, so nothing is announced; review the drafts and publish the ones you want. A changelog can run up to 10 imports an hour.

Zuletzt aktualisiert am