Skip to content

Improve README design and contents#10065

Merged
ahukkanen merged 12 commits intodevelopfrom
chore/new-readme
Nov 23, 2022
Merged

Improve README design and contents#10065
ahukkanen merged 12 commits intodevelopfrom
chore/new-readme

Conversation

@andreslucena
Copy link
Copy Markdown
Member

🎩 What? Why?

This PR updates the README with multiple improvements:

  1. A revamped design, with many ideas from ZenML README:
    1.1. using emojis for the section titles
    1.2. top centered section with links (adapted to AsciiDoc)
    1.3. learn more table
  2. Use AsciiDoc variables to DRY and clean up the URLs (on some places like the shields and the top section we can't use that)
  3. Renames the section for Donations to Financial contributions, with new subsections: "Members" and "Partners"
  4. Improving the explanation in "Contribute" section
  5. Renaming "Authorizations Strategies" section to "Permissions" and improving the wording there

Testing

You can see it at https://github.com/decidim/decidim/blob/98f5827a4e9cdffe64741ea9944bc23b403dcf1d/README.adoc

♥️ Thank you!

@andreslucena andreslucena added the type: internal PRs that aren't necessary to add to the CHANGELOG for implementers label Nov 14, 2022
Copy link
Copy Markdown
Contributor

@ahukkanen ahukkanen left a comment

Choose a reason for hiding this comment

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

Really nice improvement! 🤩

I added a couple of suggestions below.

@ahukkanen ahukkanen merged commit a444b8c into develop Nov 23, 2022
@ahukkanen ahukkanen deleted the chore/new-readme branch November 23, 2022 10:29
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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: internal PRs that aren't necessary to add to the CHANGELOG for implementers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants