Skip to main content

Release Notes Writing Guide

This document provides guidance for creating and maintaining ToothFairyAI release notes.

File Naming Convention​

release-notes-YYYY-MM-DD-feature-DDMMYY.md
  • YYYY-MM-DD: Full release date (e.g., 2026-01-04)
  • DDMMYY: Compact date suffix (e.g., 040125)

Example: release-notes-2026-01-04-feature-040125.md

Document Structure​

1. Title​

Two accepted formats:

# What's New in Version X.Y.Z

or for major releases:

# 🧚 Some updates have dropped

2. Release Date​

Italicized, immediately after title:

*Released on Month DD, YYYY*

3. Introduction Paragraph​

Brief summary of key features (1-2 sentences), ending with 🚀:

This release introduces [feature 1], [feature 2], and [feature 3]! 🚀

4. Feature Sections​

Each major feature gets its own section:

## [Emoji] Section Title

### **Feature Name**
Description paragraph explaining the feature.

**What's New:** / **Key Features:** / **How It Works:**
- **Bold Label** - Description of the item
- **Another Label** - Another description

5. Improvements & Fixes Section (if applicable)​

## 🛠️ Improvements & Fixes

### **Improvement/Fix Name**
Description of the improvement or fix.

6. Summary Section​

Always include at the end before the footer:

## 📋 Summary

This update includes:
- **Feature Name** - Brief description
- **Another Feature** - Brief description

Always end with:

---

Thank you for using ToothFairy! We're constantly working to improve your experience. If you have any feedback or encounter any issues, please don't hesitate to reach out to our support team at [support@toothfairyai.com](mailto:support@toothfairyai.com).

**Keep building magic with AI!** 🧚‍♀️✨

vX.Y.Z

Section Emoji Reference​

Use these emojis consistently for section headers:

CategoryEmojiUsage
Pricing/Billing💡Units of Intelligence, pricing changes
Integrations/API🔌MCP servers, API endpoints, integrations
Models🤖New models, model updates
Agentic/AI Features🎯Agentic tooling, planning, orchestration
Voice🎙️Voice agents, speech features
Desktop/Platform🖥️Desktop clients, platform releases
Website/Marketing🌐Website updates, newsletter
UI/UX✨UI improvements, design updates
Summary📋Summary section (always)
Fixes/Improvements🛠️Bug fixes, improvements
Database💻Database features, code execution
Retrieval/Search📒 or 🔍Search, retrieval, Deep Search
Images/Creative🎨Image generation, editing
Vision👁️Vision models
Intelligence/Reasoning🧠Reasoning, thinking models
Chat💬Chat UI, conversations
Security🔐MFA, authentication
New Features✨General new features section

Formatting Conventions​

Bold Text​

  • Feature names in subsection headers: ### **Feature Name**
  • Labels in lists: - **Label** - Description
  • Important callouts: **Important:** text
  • Notes: **Note:** text

Lists​

Use bold labels with dashes:

**What's New:**
- **Feature One** - Description of feature one
- **Feature Two** - Description of feature two
📖 **Documentation:** [Link Text](https://docs.toothfairyai.com/docs/...)
📖 **API Documentation:** [apidocs.toothfairyai.com - Feature](https://apidocs.toothfairyai.com/#tag--Feature)

Code Blocks​

For commands or code snippets, use plain code blocks (no language specifier for shell commands):

claude mcp add toothfairy-docs "https://mcp.toothfairyai.com/sse" -t sse

Version-like strings in the body​

Important: The app detects the current release version by scanning latest.md for the last vX.Y.Z pattern (see app/src/Hooks/useReleaseNotes.js). To avoid breaking that detection, the ONLY vX.Y.Z string in a release note must be the release version in the footer. Do not write package/SDK version numbers with a lowercase v prefix in headings or body text — write them without the v (e.g. "SDK version 0.7.5" or "SDK 0.7.5", never "SDK v0.7.5"). This keeps the footer release version the only match for the detection regex.

Updating the Index​

After creating a new release note, update index.md:

  1. Add the new release at the top of the "Latest Releases" section
  2. Follow this format:
### [Version X.Y.Z - Short Feature Summary](/release-notes/release-notes-YYYY-MM-DD-feature-DDMMYY)
*Released: Month DD, YYYY*

Brief 1-2 sentence description of key features.

Updating latest.md​

The latest.md file should be a copy of the most recent release notes. After creating a new release, copy the content to latest.md.

Style Guidelines​

  1. Tone: Enthusiastic but professional. Use "we" and "you" to speak directly to users.
  2. Language: British English spelling (organisation, behaviour, etc.)
  3. Exclamation marks: Use sparingly, mainly in intro paragraph and tagline
  4. Feature descriptions: Focus on user benefits, not just technical details
  5. Security notes: Always include warnings for security-sensitive features

Example Release Note​

# What's New in Version 0.670.0

*Released on January 15, 2026*

This release brings exciting new collaboration features and performance improvements! 🚀

## 🎯 Enhanced Collaboration

### **Real-time Co-editing**
Work together with your team on documents simultaneously.

**Key Features:**
- **Live Cursors** - See where team members are editing in real-time
- **Conflict Resolution** - Automatic handling of simultaneous edits

## 🛠️ Improvements & Fixes

### **Performance Optimizations**
We've improved response times across all agent interactions.

## 📋 Summary

This update includes:
- **Real-time Co-editing** - Collaborate with team members simultaneously
- **Performance** - Faster response times across all agents

---

Thank you for using ToothFairy! We're constantly working to improve your experience. If you have any feedback or encounter any issues, please don't hesitate to reach out to our support team at [support@toothfairyai.com](mailto:support@toothfairyai.com).

**Keep building magic with AI!** 🧚‍♀️✨

v0.670.0

Checklist Before Publishing​

  • File named correctly: release-notes-YYYY-MM-DD-feature-DDMMYY.md
  • Title format correct
  • Release date in italics
  • Introduction paragraph with 🚀
  • All sections have appropriate emojis
  • Summary section included with 📋
  • Footer with support email and tagline
  • Version number at the end
  • No extra vX.Y.Z strings in the body (only the footer release version) so the app's version detection isn't misled
  • index.md updated with new release
  • latest.md updated with new release content
Last updated on