Skip to content

docs: refresh README for Modrinth#238

Merged
Jakubk15 merged 9 commits into
masterfrom
codex/readme-modrinth-refresh
Jul 19, 2026
Merged

docs: refresh README for Modrinth#238
Jakubk15 merged 9 commits into
masterfrom
codex/readme-modrinth-refresh

Conversation

@Jakubk15

Copy link
Copy Markdown
Member

Summary

  • rewrite the README around the plugin's player-facing delivery experience
  • document verified features such as parcel sizes, priority delivery, returns, economy fees, administration tools, and optional Discord notifications
  • add a Modrinth-focused quick start, requirements, project status, and download call-to-action
  • preserve contributor, support, development-build, and sponsor information

Why

The README is synchronized directly to Modrinth, the project's main publishing platform. The previous copy was sparse, contained discouraging early-stage wording, and did not explain why server owners or players should try ParcelLockers.

Impact

Server owners now get a scannable overview of compatibility, setup, permissions, customization, and integrations, while players get a clearer picture of the gameplay experience the plugin adds.

Validation

  • ./gradlew.bat test — BUILD SUCCESSFUL
  • git diff --check — clean
  • verified required Modrinth, Paper/Purpur, Java 21, Vault, DiscordSRV, parcel return, priority-delivery, and permission content
  • verified no relative README image URLs or unsupported Folia/Nexo claims

@gemini-code-assist gemini-code-assist Bot 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.

Code Review

This pull request updates the project's documentation by rewriting the README.md to be more engaging, benefit-led, and optimized for Modrinth. It also adds a design specification and an implementation plan under the docs directory. The reviewer feedback suggests replacing indirect GitHub blob URLs with direct raw.githubusercontent.com URLs across both the README.md and the implementation plan to avoid HTTP redirects and ensure reliable rendering on external platforms.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread docs/superpowers/plans/2026-07-15-modrinth-readme-refresh.md Outdated
Comment thread docs/superpowers/plans/2026-07-15-modrinth-readme-refresh.md Outdated
## ❤️ Special thanks

[<img src="https://user-images.githubusercontent.com/65517973/210912946-447a6b9a-2685-4796-9482-a44bffc727ce.png" alt="JetBrains" width="150">](https://www.jetbrains.com)
[<img src="https://github.com/EternalCodeTeam/ParcelLockers/blob/master/.github/assets/sentry.svg?raw=true" alt="Sentry logo" width="150" height="150">](https://www.sentry.io)

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.

medium

Using direct raw.githubusercontent.com URLs is preferred over github.com/.../blob/.../?raw=true because it avoids an HTTP redirect and is more reliable when rendered on external platforms like Modrinth.

Suggested change
[<img src="https://github.com/EternalCodeTeam/ParcelLockers/blob/master/.github/assets/sentry.svg?raw=true" alt="Sentry logo" width="150" height="150">](https://www.sentry.io)
[<img src="https://raw.githubusercontent.com/EternalCodeTeam/ParcelLockers/master/.github/assets/sentry.svg" alt="Sentry logo" width="150" height="150">](https://www.sentry.io)

@Jakubk15
Jakubk15 marked this pull request as ready for review July 19, 2026 16:39
@Jakubk15
Jakubk15 merged commit 3b36f57 into master Jul 19, 2026
1 check passed
@Jakubk15
Jakubk15 deleted the codex/readme-modrinth-refresh branch July 19, 2026 16:39
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.

1 participant