​

Release Notes System

​

Quick Start

1. Read AI Agent Guide
2. Select appropriate template from below
3. Follow the 6-step process
4. Validate against checklists

1. Read Playbook for workflow
2. Keep Quick Reference open while writing
3. Follow Style Guide for writing standards

​

Templates

​

Reference Guides

​

AI Agent Resources

​

File Organization

release-notes/
├── _meta/                     # This documentation
│   ├── index.mdx              # This file
│   ├── AI-AGENT-GUIDE.md      # AI agent instructions (all doc types)
│   ├── DOCUMENTATION-STANDARDS.md  # Universal standards
│   ├── NEW-DOC-GUIDE.md       # Creating new docs
│   ├── UPDATE-GUIDE.md        # Updating existing docs
│   ├── PLAYBOOK.md            # Human workflow
│   ├── STYLE.md               # Writing standards
│   ├── QUICKREF.md            # One-page reference
│   ├── VERIFICATION.md        # Mandatory verification steps
│   ├── MINTLIFY-REFERENCE.md  # Component reference
│   ├── taxonomy.mdx           # Tags & components
│   ├── audience-guide.mdx     # Audience selection
│   ├── icon-guide.mdx         # Visual standards
│   ├── template.mdx           # Base template
│   ├── template-feature.mdx   # Feature template
│   ├── template-major-release.mdx  # Major release template
│   ├── template-hotfix.mdx    # Hotfix template
│   └── template-security.mdx  # Security template
├── _archive/                  # Pre-2024 releases
├── 2025/                      # 2025 releases
├── 2026/                      # 2026 releases
├── index.mdx                  # Main release notes landing
└── template.mdx               # Legacy template (for reference)

​

Standards at a Glance

​

Common Workflows

​

Creating a New Feature Release

1. Open template-feature.mdx
2. Fill in frontmatter using taxonomy.mdx
3. Write sections following STYLE.md
4. Validate with QUICKREF.md checklist
5. Place in correct folder

​

Writing a Security Update

1. Open template-security.mdx
2. Fill vulnerability details
3. Include impact assessment table
4. Add timeline
5. Mark as hotfix severity
6. Publish immediately

​

Batch Writing Multiple Releases

1. Keep QUICKREF.md open
2. Use consistent tags from taxonomy
3. Follow same structure for each
4. Validate each against checklist
5. Update indices when done

​

Validation Checklist

• Follows selected template
• All frontmatter fields valid
• Tags from approved taxonomy
• Audience appropriate
• No internal jargon
• UI references exact and bold
• Length 200-400 words
• Benefits clear in first sentences
• Instructions actionable
• Breaking changes documented (if any)
• File named correctly
• In correct folder location

​

Need Help?

• Questions about taxonomy? → Taxonomy guide
• Unsure about style? → Style guide
• Don’t know workflow? → Playbook
• Quick lookup needed? → Quick reference
• Creating NEW documentation? → New Doc Guide
• UPDATING existing docs? → Update Guide
• AI generation issues? → AI Agent Guide
• Need universal standards? → Documentation Standards
• Need to verify features? → Verification Standards
• Component questions? → Mintlify Reference