Skip to main content

​
Overview

This template provides structure for documenting platform updates consistently.
This page is for documentation maintainers. Regular users can ignore this template.

​
Entry Structure

​
Frontmatter

---
title: "Update Title"
date: "YYYY-MM-DD"
version: "X.X.X" # Optional
audience: "All | Creators | Producers | Artists"
tags: ["feature", "improvement", "bugfix", "deprecation"]
---

​
Content Sections

Each changelog entry should include:
1

Summary

2-3 sentence overview of what changed.
2

What's New/Changed

Bullet points of specific changes:
  • Feature additions
  • Behavior changes
  • UI updates
3

Why It Matters

Brief explanation of user benefit.
4

How to Use (if applicable)

Quick instructions for new features.
5

Known Issues (if any)

Current limitations or bugs being tracked.
6

Links

Related documentation pages.

​
Example Entry

---
title: "Producer Analytics Dashboard"
date: "2025-11-15"
audience: "Producers"
tags: ["feature", "analytics"]
---

## Summary

New comprehensive analytics dashboard for producers with detailed performance metrics.

## What's New

- Real-time play and completion tracking
- Contribution value visualization
- XP and tier progression display
- Achievement milestone tracking

## Why It Matters

Producers can now understand their performance at a glance and track progress toward goals.

## How to Use

1. Navigate to Backstage > Insights
2. Select your artist profile
3. Explore the new dashboard tabs

## Known Issues

- Geographic data may be delayed for new tracks
- Some historical data may not be available

## Related

- [Analytics Guide](/help/analytics/dashboards)
- [Contribution Formula](/help/earnings/formula)

​
Writing Guidelines

​
Tone

  • Clear and direct
  • User-focused (benefits, not technical details)
  • Professional but approachable

​
Length

  • Summary: 2-3 sentences
  • What’s New: 3-7 bullet points
  • Total entry: 200-400 words

​
Categories

TagUse For
featureNew functionality
improvementEnhancements to existing features
bugfixResolved issues
deprecationFeatures being removed
securitySecurity-related updates

​
File Naming

Use format: YYYY-MM-DD-short-title.mdx Examples:
  • 2025-11-15-producer-dashboard.mdx
  • 2025-11-20-licensing-update.mdx

​
Review Checklist

Before publishing:
  • Frontmatter is complete
  • Summary is clear and concise
  • All changed features are documented
  • User benefit is explained
  • Links to related docs are included
  • No sensitive information exposed
  • Screenshots are redacted if needed
  • Navigation updated in docs.json
Last modified on December 5, 2025