Skip to content
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

Improve README readability #1617

Merged
merged 2 commits into from
Aug 16, 2020
Merged

Improve README readability #1617

merged 2 commits into from
Aug 16, 2020

Conversation

ggrossetie
Copy link
Contributor

📑 Summary

Improve the readability of the README:

  • Fix link to the changelog
  • Remove changelog from the readme
  • Use titles sparingly
  • Add emojis! 🎉

📏 Design Decisions

In my opinion, the README is hard to parse because there are too many bold paragraphs and titles.

📋 Tasks

Make sure you

  • 📖 have read the contribution guidelines
  • 💻 have added unit/e2e tests (not applicable)
  • 🔖 targeted develop branch

ggrossetie and others added 2 commits August 15, 2020 14:59
- Fix link to changelog
- Remove changelog from readme
- Use titles sparsely
- Add emojis! 🎉
@ggrossetie
Copy link
Contributor Author

Here's the result:

Current Proposal
about-current about

@ggrossetie ggrossetie marked this pull request as ready for review August 15, 2020 13:16
@knsv knsv requested a review from NeilCuzon August 15, 2020 17:15
@NeilCuzon
Copy link
Member

Looks great! I love the emojis.

@NeilCuzon NeilCuzon merged commit e9060a3 into mermaid-js:develop Aug 16, 2020
@ggrossetie
Copy link
Contributor Author

Thanks @NeilCuzon!

I would like to improve the documentation, published at https://mermaid-js.github.io/mermaid, but I'm not sure where the content is stored.
I found several "copies" of the documentation:

I would recommend to archive deprecated repositories to make it easier to contribute documentation.

@NeilCuzon
Copy link
Member

the content on display here: https://mermaid-js.github.io/mermaid, are auto-generated from the docs in the master branch.
it does have some sister projects and those could be the other repositories in the project.

there is a shortage of hands at the moment, your help would be very much welcome.

your earlier contribution was in the right place actually, @knsv is generally the one who merges the develop and master branches when there is a new version for release.

if you would like, you can make some edits to the docs here: https://github.com/mermaid-js/mermaid/tree/develop/docs

@ggrossetie
Copy link
Contributor Author

Thanks for the clarification.
I will do my best to help 😉

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.

2 participants