docs: Update API changelog, add APIv2+APIv3 version documentation#6308
docs: Update API changelog, add APIv2+APIv3 version documentation#6308bthomee merged 9 commits intoXRPLF:developfrom
Conversation
mvadari
changed the title
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the API changelog documentation by extracting version-specific breaking changes into dedicated files and expanding the main changelog with comprehensive release information.
Changes:
- Created separate documentation files for API v2 and API v3 breaking changes
- Expanded the API-CHANGELOG.md with detailed, chronologically-ordered release notes for versions 2.0.0 through 3.1.0
- Added a new step in the release process to update the API changelog
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| API-CHANGELOG.md | Reorganized to reference separate version docs, added comprehensive release notes for versions 2.0.1 through 3.1.0 with PR references |
| API-VERSION-2.md | New file documenting all breaking changes in API version 2 |
| API-VERSION-3.md | New file documenting all breaking changes in API version 3 (beta) |
| CONTRIBUTING.md | Added step 12 to the release process for updating the API changelog |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mvadari
added
Ready to merge
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #6308 +/- ##
=======================================
Coverage 79.9% 79.9%
=======================================
Files 839 839
Lines 65530 65530
Branches 7273 7269 -4
=======================================
+ Hits 52326 52330 +4
+ Misses 13204 13200 -4 see 3 files with indirect coverage changes 🚀 New features to boost your workflow:
|
2 participants
High Level Overview of Change
This PR cleans up the
API-CHANGELOG.mdfile. It moves the version-specific documentation to other files and fleshes out the changelog with all the API-related changes in each version.Context of Change
The current
API-CHANGELOG.mdfile is rather messy and hard to navigate.Type of Change
API Impact
N/A
Test Plan
No code changes.