Documentation proofreading

Happy Hacktoberfest!

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Problem

There’s a new documentation. However, I’m not a native english speaker and the documentation really needs some external proofreading.

List of pages:

• Tutorials
  • React (@BitYog)
  • CLI (@BitYog)
• Guides
  • How plurals work (@ayushgangrade)
  • Dynamic loading of translations (@ayushgangrade)
• API references
  • React (@Andrew565)
  • CLI (@Andrew565)
  • Configuration (@Andrew565)
• Releases
  • Migration from 0.x to 1.x (@Andrew565)

How-to

All documentation is in docs folder. It’s build using Sphinx Document Generator and uses reStructuredText.

If you want to build documentation locally, you need to have Python installed.

1. Install pipenv tool:

pip install pipenv

1. Install project dependencies

pipenv install

After making any changes, simply run make html inside docs folder.

cd docs
make html

Support

Need a help? Ping me on gitter. I live in Europe/Prague UTC+2 timezone and most of the time I answer questions on gitter instantly.

[ayushgangrade]

Cool! I’ll start working on the guides! @Andrew565

[BitYog]

Thanks. I’m a first timer in open source, and I absolutely loved your work and the way you quickly replied. BTW, got any GitHub tips?