This page offers an overview of best-practice suggestions for contributing documentation. We strongly recommend reviewing this page before contributing to the Ergo Framework documentation.
If you have found a mistake or a misprint in the documentation, please report it at https://github.com/ergo-services/docs/issues
In general, there are two main types of contributions:
- General improvements: typo corrections, fixing broken refs or links, correcting inaccurate or out-of-date information, and offering better explanations through clearer writing and additional examples.
- New features or new pages: adding a page of documentation that we haven't yet covered or documenting a new feature that has been added to Ergo Framework since the last release.
We welcome both kinds of contributions from our users and are always aiming to improve our documentation as much and as often as possible.
To maintain a sense of consistency and quality over time, here are a few tips:
- Understand that our documents are all released under a Creative Commons Attribution-ShareAlike 4.0 license CC BY SA. This means that your contributions are being released to Ergo Framework community to use, share, remix, and distribute as they see fit, provided any distribution takes place under the same licensing.
- Read through some of the documents we've already created. You'll notice that there is a consistent structure to most of them. By reading through some of our existing documentation, you will get a feeling of the overall structure and style.
- Familiarize yourself with Ergo Framework before starting.
- Make your contributions in the right place. We use branches for different translations, so make sure the branch name before making a pull request.