Skip to content

Editable package markdown - #1952

Open
ethangreen-dev wants to merge 8 commits into
masterfrom
feat/update-readme
Open

ethangreen-dev wants to merge 8 commits into
masterfrom
feat/update-readme

Conversation

@ethangreen-dev

@ethangreen-dev ethangreen-dev commented Sep 1, 2026 •

Copy link
Copy Markdown
Member

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

image The author view on the new last edited timestamp and edit button. image Mobile view image Versions list with minimal edited pill. image Upload page option to use the previous version's readme or download it. image The readme editor. image And the same editor for a failure state. image Mobile of the same view. Squashed but maybe usable.

Comment thread apps/cyberstorm-remix/app/upload/components/UploadFileSection.tsx Fixed
@coderabbitai

coderabbitai Bot commented Sep 1, 2026 •

Copy link
Copy Markdown
Contributor

Review Change StackReview Change Stack

Walkthrough

The 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 50ba3

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)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 16.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 54 functions across 47 files. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely identifies the main change: editable package markdown.
Description check ✅ Passed The description directly explains the new README and CHANGELOG editing feature and its related upload, display, and editor behavior.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 2
⚔️ Resolve merge conflicts 💡
  • Resolve merge conflict in branch feat/update-readme
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@ethangreen-dev ethangreen-dev changed the title Editable package contents Editable package markdown Sep 1, 2026
coderabbitai[bot]

This comment was marked as resolved.

@Chaosyr

Chaosyr commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

@ethangreen-dev

Copy link
Copy Markdown
Member Author

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.

This comment was marked as resolved.

@Chaosyr

Chaosyr commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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!!

Chaos-New-New-Model1.png

coderabbitai[bot]

This comment was marked as resolved.

@ethangreen-dev
ethangreen-dev force-pushed the feat/update-readme branch 2 times, most recently from ddac508 to 6c95c17 Compare September 15, 2026 17:28

@Oksamies Oksamies left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Answer questions at the very least

Comment thread packages/thunderstore-api/src/get/packageReadme.ts Outdated
Comment thread packages/thunderstore-api/src/get/packageVersionMarkdownRaw.ts Outdated
Comment thread packages/thunderstore-api/src/post/packageVersionMarkdown.ts Outdated
Comment thread packages/thunderstore-api/src/schemas/responseSchemas.ts Outdated
Comment thread apps/cyberstorm-remix/vitest.config.ts Outdated
@codecov

codecov Bot commented Sep 23, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 78.68713% with 250 lines in your changes missing coverage. Please review.
✅ Project coverage is 41.29%. Comparing base (47166b4) to head (717669b).
⚠️ Report is 8 commits behind head on master.

Files with missing lines Patch % Lines
...s/cyberstorm-remix/app/p/readmeEdit/ReadmeEdit.tsx 88.72% 70 Missing ⚠️
...rstorm-remix/app/p/readmeEdit/overrideMigration.ts 10.20% 44 Missing ⚠️
apps/cyberstorm-remix/app/upload/uploadHooks.ts 11.90% 37 Missing ⚠️
...-api/src/get/packageVersionChangelogMarkdownRaw.ts 9.67% 28 Missing ⚠️
...ore-api/src/get/packageVersionReadmeMarkdownRaw.ts 9.67% 28 Missing ⚠️
...berstorm/src/newComponents/CodeInput/CodeInput.tsx 0.00% 18 Missing ⚠️
.../cyberstorm-remix/cyberstorm/utils/LinkLibrary.tsx 16.66% 5 Missing ⚠️
apps/cyberstorm-remix/app/routes.ts 0.00% 4 Missing ⚠️
apps/cyberstorm-remix/app/upload/upload.tsx 73.33% 4 Missing ⚠️
packages/dapper-fake/src/fakers/markup.ts 0.00% 4 Missing ⚠️
... and 5 more
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This branch has not been deployed

No deployments
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.

5 participants