Content Template
Copy the content below to a new
.mdx file in src/content/releases/ or src/content/upcoming/. This unified template works for both finished releases and planned features.Directory Placement
Move files from
upcoming/ to releases/ when a feature is completed. The frontmatter structure remains exactly the same.Metadata Options
- breaking: true - Will display a red 'Breaking Change' warning banner.
- security: true - Will add a red 'Security Update' ribbon.
_TEMPLATE.mdxMARKDOWN
---
title: "Release Title / Feature Name"
date: "YYYY-MM-DD"
author: "Team Name"
project: "Project Name"
type: "minor" # major | minor | patch | announcement | upcoming
status: "released" # released | planned | in-progress | testing | delayed
priority: "medium" # low | medium | high
breaking: false # Set to true if this release introduces breaking changes
security: false # Set to true if this release fixes security vulnerabilities
tags: ["Tag1", "Tag2"]
image: "" # Optional: URL to an image (e.g. /images/releases/v1.0.0.png)
deployed: [] # Optional: ["prod", "staging"] - Environments where this is deployed
requester:
team: "Requesting Team"
app: "Application Name"
member: "Requester Name"
support:
on_call: "On-Call Person"
team_slack: "#channel-name"
ticket_link: "https://ticket-system.com/link"
---
{/*
INSTRUCTIONS FOR AI CODING AGENTS:
1. CONTEXT:
- Project: Portal (Enterprise management platform integrating Auth, Docs, and APIs).
- Tech Stack: Next.js (Frontend), GoFrame (Backend), Ent ORM, Casdoor (Auth).
- Purpose: This file is an MDX source for the /docs/releases or /docs/upcoming sections.
2. TARGET DIRECTORY:
- Use 'src/content/releases/' for completed updates.
- Use 'src/content/upcoming/' for roadmap/planned features.
3. METADATA (Frontmatter):
- 'date': MUST be YYYY-MM-DD format. Primary sorting key.
- 'type': 'major'|'minor'|'patch'|'announcement'|'upcoming'.
- 'status': 'released'|'planned'|'in-progress'|'testing'|'delayed'.
- 'deployed': Array of environments e.g. ["prod"], ["staging"], ["prod", "staging"].
4. LIFECYCLE:
- To move an item from Roadmap to Release, simply move the file to 'src/content/releases/'
and update 'status' to 'released' and 'type' to 'major/minor/patch'.
5. FORMATTING:
- Maintain the Frontmatter structure exactly.
- Use standard Markdown for the body.
*/}
### 🚀 Highlights
Provide a high-level summary of the release or feature. What is the main value proposition?
{/* Optional: Use this section for critical breaking changes */}
{/*
### ⚠️ Breaking Changes
- **Component**: Description of what changed and why it breaks.
- **Config**: New required configuration.
*/}
### 🆕 What's New?
- **Feature Name**: Description of the new feature.
- **Another Feature**: Description.
### 🐛 Bug Fixes
- Fixed an issue where...
- Resolved a crash when...
### 🔧 Improvements
- Optimized performance for...
- Updated UI for...
{/* Optional: Use this section for deprecation warnings */}
{/*
### 📉 Deprecations
- Feature X is deprecated and will be removed in version Y.
*/}
{/* Optional: Use this section for upgrade instructions */}
{/*
### 🔄 Migration Guide
1. Step 1
2. Step 2
*/}
### 📅 Timeline / Status (For Upcoming Features)
- **Design:** [Status]
- **Development:** [Status]
- **Target Release:** [Date/Quarter]