Skip to content

Conversation

sunt05
Copy link

@sunt05 sunt05 commented Jul 25, 2025

Summary

  • Added CHANGELOG.md to the documentation site for better visibility of recent changes
  • Created new changelog.rst page that includes the main CHANGELOG.md file
  • Integrated changelog into documentation navigation and index page
  • Added comprehensive Kiro specification for current and future enhancements

Implementation Details

  • Used Sphinx's literalinclude directive to include CHANGELOG.md directly
  • Maintains single source of truth - no duplicate content
  • Added to "For developers/contributors" section in navigation
  • Added reference link in main index page for easy discovery

Kiro Specification

Complete specification added in .claude/specs/add-changelog-to-docs/:

  • requirements.md: 24 requirements in EARS notation
  • design.md: Technical architecture including future automation
  • tasks.md: 26 implementation tasks across 6 phases
  • tag-system-proposal.md: Proposal for user/dev changelog filtering

Testing

  • Verified changelog.rst syntax is correct
  • Confirmed navigation links are properly added
  • Documentation builds successfully (requires local build environment)

Future Enhancements

As detailed in the specification:

  • Automatic changelog updates via CI/CD
  • Filtered views for user-facing vs developer changes
  • Integration with release automation
  • Improved tagging system ([user:new], [dev:new], etc.)

Fixes #537

Test plan

  • Documentation builds without errors
  • Changelog page displays correctly
  • Navigation links work properly
  • CHANGELOG.md content is properly rendered

sunt05 added 2 commits July 25, 2025 15:59
- Create changelog.rst that includes the main CHANGELOG.md file
- Add changelog to the documentation navigation under 'For developers/contributors'
- Add reference link in the main index page for easy access
- Uses literalinclude directive to maintain single source of truth

Fixes #537
- Comprehensive specification following Kiro methodology
- Requirements in EARS notation
- Technical design documentation
- Implementation tasks with estimates
- Includes future automation and filtering enhancements
@sunt05 sunt05 marked this pull request as draft July 25, 2025 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add changelog to docs site

1 participant