QUICKSTART

FlowX Release Notes - Quick Start

One Command to Rule Them All

./scripts/release-notes-full 5.2.1 december-2025

That’s it! This command:

1. ✅ Creates folder: release-notes/v5.x/v5.2.1-december-2025/
2. ✅ Generates release notes MDX from Jira (all FlowX projects)
3. ✅ Creates deployment guidelines template
4. ✅ Updates docs.json navigation automatically
5. ✅ Ready to review and customize

---

What You Get

Files Created

release-notes/v5.x/v5.2.1-december-2025/
├── v5.2.1-december-2025.mdx         # Release notes (from Jira)
└── deployment-guidelines-v5.2.1.mdx  # Deployment guide (template)

docs.json Updated

Your new release automatically appears in the navigation:

{
  "group": "v5.2.1 - December 2025",
  "icon": "scroll",
  "pages": [
    "release-notes/v5.x/v5.2.1-december-2025/v5.2.1-december-2025",
    "release-notes/v5.x/v5.2.1-december-2025/deployment-guidelines-v5.2.1"
  ]
}

---

Customize Your Release Notes

The generated MDX includes TODO markers where you add rich content:

1. Overview sections - Detailed feature descriptions
2. Key Features cards - Business value highlights
3. Screenshots/videos - Visual demonstrations
4. Code examples - Implementation guides
5. Benefits - Business impact

See RELEASE-NOTES-GUIDE.md for full customization details.

---

Quick Commands

# Generate full release notes
./scripts/release-notes-full 5.2.1 december-2025

# Test Jira connection
./scripts/release-notes --test

# List available versions
./scripts/release-notes --versions

# Generate MDX only (no folder/docs.json update)
./scripts/release-notes 5.2.1

---

Example Workflow

# 1. Generate everything
./scripts/release-notes-full 5.3.0 january-2026

# 2. Review files
cursor release-notes/v5.x/v5.3.0-january-2026/v5.3.0-january-2026.mdx

# 3. Customize
#    - Fill in TODO sections
#    - Add screenshots
#    - Update deployment guidelines

# 4. Test locally
#    - Run Mintlify dev server
#    - Check navigation works
#    - Verify formatting

# 5. Commit and push
git add release-notes/ docs.json
git commit -m "Add release notes for v5.3.0"
git push

---

Projects Included Automatically

The script fetches issues from:

• CORE
• AI Integration
• Rendering Product Team
• MVP Team
• Plugins
• Platform Team
• Documentation

All filtered by the fix version you specify.

---

Troubleshooting

Connection Issues

./scripts/release-notes --test

Version Not Found

./scripts/release-notes --versions CORE

Need Different Projects

Edit the JQL query in scripts/release-notes-full (line 49)

---

Files Reference

File	Purpose
release-notes-full	Main command - Full integration
release-notes	Quick MDX generation only
jira-test-connection.js	Test Jira API
jira-list-versions.js	List available versions
jira-to-rich-release-notes.js	MDX generator (used by commands)

---

Need Help?

• Customization: See RELEASE-NOTES-GUIDE.md
• MDX Components: Check existing release notes in release-notes/v5.x/
• Troubleshooting: See JIRA-INTEGRATION.md
• Quick reference: See README.md

---

Ready to create your first release notes?

./scripts/release-notes-full YOUR_VERSION month-year

🎉 Done!