Documentation

Everything you need to know to configure and use whatsnew.bot effectively.

Quick Start Guide
Get up and running in 5 minutes
1

Sign in to whatsnew.bot

Use your credentials to access the dashboard

2

Configure your AI provider

Go to Settings and add your API key for OpenAI, Anthropic, or Groq

3

Add a GitHub project

Enter your repository URL and optionally add a Personal Access Token for private repos

4

Sync your commits

Click "Sync Now" to fetch commits and generate changelogs

5

View your changelogs

Choose between Tech, Support, or Sales view for audience-specific content

Settings Reference

GitHub Configuration
Connect to your GitHub repositories

Personal Access Token (Global)

A global GitHub token used for all projects that don't have a project-specific token.

Format: ghp_xxxxxxxxxxxxxxxxxxxx

Per-Project Token

Optional token specific to a single project. Useful when different repositories require different access levels.

How to create a GitHub Token

  1. Go to GitHub Settings → Developer settings → Personal access tokens
  2. Click "Generate new token (classic)"
  3. Enter a name (e.g., "whatsnew.bot")
  4. Select the repo scope
  5. Click "Generate token" and copy it
AI Provider Configuration
Configure your AI provider for changelog generation

Default Provider

Choose which AI provider to use for generating changelog entries.

OpenAI (GPT-4)Anthropic (Claude)Groq (Llama/Mixtral)

OpenAI

GPT-4 for high-quality output

sk-xxxx...

Anthropic

Claude for nuanced content

sk-ant-xxxx...

Groq

Fast inference with Llama/Mixtral

gsk_xxxx...

General Settings
Application-wide configuration options

Timezone

Display timezone for all dates and times.

Europe/AmsterdamEurope/BrusselsUTC

Language

Default language for generated changelog content.

Dutch (nl)English (en)

Data Retention

How long changelog entries are kept in the system (7-365 days).

Default: 90 days

Project Settings

Project Configuration Options
Settings available for each connected repository

Project Name

A friendly name for your project displayed in the dashboard.

GitHub Repository URL

The full URL of your GitHub repository (e.g., https://github.com/owner/repo).

GitHub Personal Access Token

Optional token for private repositories. Overrides the global token.

Sync Frequency

How often to automatically sync commits from GitHub.

ManualHourlyEvery 3hEvery 12hDaily

Webhook Integration

Enable real-time updates when commits are pushed to your repository.

When enabled, configure your GitHub repository webhook to:

https://whatsnew-bot-worker.pmink.workers.dev/webhook/github/[project-id]

Entry Categories

Changelog Entry Classification
How entries are automatically categorized

Feature

New functionality added to the product

Improvement

Enhancements to existing features

Bugfix

Fixes for reported issues

Security

Security patches and updates

Performance

Speed and efficiency improvements

Documentation

Updates to documentation

Need Help?

Check out the features page or get started with your first project.