Improve README design and contents#10065
Merged
Conversation
ahukkanen
requested changes
Nov 15, 2022
Contributor
ahukkanen
left a comment
There was a problem hiding this comment.
Really nice improvement! 🤩
I added a couple of suggestions below.
... and authorizations" Suggested by code review
ahukkanen
approved these changes
Nov 23, 2022
Quentinchampenois
pushed a commit
to Quentinchampenois/decidim
that referenced
this pull request
Nov 23, 2022
* Change top section, with centered logo * Add URIs (links) with variables instead of full URL * Move badges to top * Improve 'How to contribute' section explanation * Improve 'Authorization strategies' section explanation * Add 'Learn More' section * Fix rubydoc link to documentation * Fix space on Table of Contents * Rename "Permissions" to "Identity verifications..." ... and authorizations" Suggested by code review * Add "Authentication options" section * Fix typo in 'Our latest releases' * Add link to Authorization modules in decidim.org
entantoencuanto
added a commit
that referenced
this pull request
Nov 28, 2022
* develop: Redesign: verifications (#9759) Fix machine translations at the API (#9652) Add title and description to the attachment API type (#10114) Correct the "voted for this" string in the budgets component (#10113) Fix filter URL not updated with the text search input (#9618) Improve README design and contents (#10065) Update bulletin board to 0.24 for Ruby 3.1 compatibility (#9766) Fix some oversights in the release notes for the next release (#10078) Fix bug regarding user group moderation action logs (#10085) Fix wrong capitalization in i18n values and add missing keys (#10072) Enhance templates engine (#10015) Add slash in PR linter configuration (#10074) Allow blocking a UserGroup (#10021) Enable newsletters for admin on seeds (#10073)
entantoencuanto
added a commit
that referenced
this pull request
Nov 28, 2022
* develop: Redesign: verifications (#9759) Fix machine translations at the API (#9652) Add title and description to the attachment API type (#10114) Correct the "voted for this" string in the budgets component (#10113) Fix filter URL not updated with the text search input (#9618) Improve README design and contents (#10065)
This file contains hidden or 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
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.
🎩 What? Why?
This PR updates the README with multiple improvements:
1.1. using emojis for the section titles
1.2. top centered section with links (adapted to AsciiDoc)
1.3. learn more table
Testing
You can see it at https://github.com/decidim/decidim/blob/98f5827a4e9cdffe64741ea9944bc23b403dcf1d/README.adoc