Skip to content

feat:add readme for mods #398

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

atybdot
Copy link

@atybdot atybdot commented Dec 31, 2024

readme component that fetch the readme of respective mod and display it.

Features it add :

  1. render readme file of each mod
  2. link to the respective readme file

screenshots
image
image

@nocanoa nocanoa requested a review from mr-cheffy January 1, 2025 16:25
@atybdot
Copy link
Author

atybdot commented Jan 2, 2025

@mr-cheff i didn't knew there was a pnpm-lock file.
I thought i created it. and vs-code was recommending me that i should only have one lock per project, otherwise there may be conflicts. that's why i deleted it.

@mr-cheffy
Copy link
Contributor

Im still trying to figure out if we really want READMEs...

@atybdot
Copy link
Author

atybdot commented Jan 2, 2025

i was going through code-base,i found a to-do:add readme.
That's why i did it.Although it's up to you to decide, i recommend adding this, could be useful for detailed description of mods ,dos and dont's etc..

@nocanoa nocanoa added the mr. m ⌚ waithing for cheff opinion/confirmation label Jan 3, 2025
@nocanoa nocanoa added the invalid This doesn't seem right label Jan 20, 2025
@Kaedriz
Copy link

Kaedriz commented May 3, 2025

Im still trying to figure out if we really want READMEs...

Maybe not exclusively README, but some sort of larger introduction/instructions text panel would be appreciated.

Markdown is good enough for that, and supports semantics like quoting, tables etc.

As of right now, mods that don't work right out-of-the-box (so without customization) could be easily marked as broken.

While on the topic of mods homepage, here is my list of things which it would benefit from, but require additional work:

  • Possibly of gallery of images, just to showcase mod more than just preview, which often doesn't even show mod effect itself.
  • Changelog functionality for specific mods, so users can know which things were changed, without delving into mod's GitHub page, let alone CSS files..
  • This one being slightly off-topic, but maybe some local check when installing mod, that will search for mod conflicts (static, defined by mod's authors, with slight explanation what might not work with 2 mods together)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
invalid This doesn't seem right mr. m ⌚ waithing for cheff opinion/confirmation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants