Editable package markdown - #1952
ethangreen-dev wants to merge 8 commits into
Conversation
WalkthroughThe change adds a package version README and changelog editor with authenticated loading, preview, validation, save, discard, import, and migration workflows. Edited metadata is added to shared types, schemas, API endpoints, and package displays. Uploads can detect previous README overrides and carry or download them. New routing, links, responsive layouts, navigation changes, and ZIP parsing tests support the workflow. Priority: ➖ Normal — Schedule the package markdown editing feature because it spans README and changelog editing, edited-content indicators, upload carry-forward controls, and related package-management UI without urgent external impact evidence. Merge Risk: 🟡 Moderate · up to A user can opt to carry a site-edited README into an uploaded version, then lose that choice if the team changes before submission completes. The selected option should be preserved for the submitted package before merge. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches 💡 2⚔️ Resolve merge conflicts 💡
🛠️ Fix failing CI checks 💡
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Have a question, does the site edited version of the README/CHANGELOG get saved to that versions zip, or is it stored next to the package? /cur |
Stored in the DB, not in the package archive. We architecturally cannot easily edit package contents, so this is the best option for now. |
Got it, thanks for the clarification!! |
50ba3cb to
3fc8c89
Compare
ddac508 to
6c95c17
Compare
Oksamies
left a comment
There was a problem hiding this comment.
Answer questions at the very least
f980b0c to
717669b
Compare
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #1952 +/- ##
==========================================
+ Coverage 34.23% 41.29% +7.06%
==========================================
Files 400 410 +10
Lines 16817 19531 +2714
Branches 1175 1361 +186
==========================================
+ Hits 5757 8065 +2308
- Misses 11060 11466 +406 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
717669b to
629db26
Compare
629db26 to
fc67abc
Compare

This PR adds the ability for users to edit README.md and CHANGELOG.md files without submitting a new package version.
Hard dependency on thunderstore-io/Thunderstore#1239