Repository navigation
v2.3.1 - Status Element Compliance & Documentation
π― Status Element Compliance & Documentation Release
This patch release focuses on 100% Atlassian ADF compliance for status elements and comprehensive user documentation.
β¨ Status Element Improvements
π Compliance with Official Atlassian Specification
- β
Schema Updated: Removed non-standard
styleattribute - β
Official Attributes:
text(required),color(required),localId(optional) - β
Official Colors:
neutral,green,red,yellow,blue,purple - β Backward Compatibility: Custom attributes preserved in metadata
π Enhanced Documentation
Quick Start Guide Improvements
- New Status Format Standards section with comprehensive examples
- Clear syntax guidance:
{status:In Progress}for basic usage - Advanced colored status:
<!-- adf:status color="green" -->{status:Complete} - Integration examples with other social elements
- Next Steps section now includes social elements category
Specification Documentation
- Updated element specifications to match official Atlassian docs exactly
- Removed non-standard attributes from documentation and examples
- Comprehensive test fixtures updated for compliance
- Round-trip conversion accuracy maintained
π§ Technical Improvements
Test Suite Updates
- β 13 comprehensive test cases for status converter
- β Updated fixtures to remove non-standard attributes
- β Integration tests with panels, tables, and lists
- β Backward compatibility tests for custom attributes
Implementation Details
- StatusConverter preserves all attributes in metadata for compatibility
- ADF to Markdown:
`Status Text`with metadata comments - Markdown to ADF: Proper status nodes with required attributes
- Round-trip accuracy: No data loss through multiple conversions
π― User Impact
For New Users
- Clear documentation on how to create status elements
- Official Atlassian compliance ensures compatibility
- Comprehensive examples for basic and advanced usage
For Existing Users
- No breaking changes - all existing functionality preserved
- Enhanced compliance improves Atlassian platform integration
- Better documentation for easier implementation
π Status Element Usage Examples
Basic Status
Task status: {status:In Progress}Colored Status
<!-- adf:status color="green" -->
{status:Complete}
<!-- adf:status color="red" -->
{status:Blocked}Available Colors
neutral(default - grey)green(success/complete)red(error/blocked)yellow(warning/in progress)blue(info)purple(custom)
π Related Links
Full Changelog: v2.3.0...v2.3.1
This release maintains 100% backward compatibility while ensuring full compliance with the official Atlassian Document Format specification.