Simpler READMEs #18
Open
Simpler READMEs #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I'm all for this 🤩 |
|
Discussed today IRL :
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current system is flooding every app PR with boring README diffs because it updates every translations ... in the meantime, the README itself feels bloated with badges and stuff like
This package allows you to install $app quickly and simply on a YunoHost server.etc ...Ultimately imho Github READMEs can't be the place where we can have a proper presentation of the app, both because it's limited in terms of i18n and styling capabilities (it's just markdown with very few HTML/CSS features available), and because we can't expect random folks to be comfortable browsing Github repositories which are more of a power-user thing.
So here's the proposal to drop i18n for the READMEs and have a kind minimalistic README instead with only the short description, encourage people to browse the app catalog instead, and dev infos. Example for Nextcloud (i still need to update the badges tho):