diff options
author | Joseph Herlant <aerostitch@debian.org> | 2019-10-27 13:05:48 -0700 |
---|---|---|
committer | Joseph Herlant <aerostitch@debian.org> | 2019-10-27 13:09:49 -0700 |
commit | 179c48d6207a5e33ddecf3684d82e0cd65b9a3d9 (patch) | |
tree | 49312d67cbc2ae5fff6993e0651d196e73e1a14d | |
parent | c1180689199de06f6e68365510d787aef4fcd928 (diff) | |
download | navit-179c48d6207a5e33ddecf3684d82e0cd65b9a3d9.tar.gz |
Add a section for contributing to the documentation
-rw-r--r-- | CONTRIBUTING.md | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4a71f995c..4a91fa02a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,8 +3,8 @@ Welcome to Navit! We welcome contributions! If you are interested in contributing to the [Navit code repo](README.md) -then checkout the [Wiki](https://wiki.navit-project.org/index.php/Main_Page) -and our [ReadTheDocs space](https://navit.readthedocs.io) +then checkout the [old Wiki](https://wiki.navit-project.org/index.php/Main_Page) +and our [new wiki hosted on ReadTheDocs](https://navit.readthedocs.io) When pushing a pull request, please make sure you follow our: * [programming guidelines](https://navit.readthedocs.io/en/trunk/development/programming_guidelines.html) @@ -55,6 +55,19 @@ If your changes are more complex, catch up new ideas, or still have some minor p So that's it, you helped Navit to go one step forward. Thank you very much :) +## Contributing on the documentation + +For the documentation we now use [readthedocs](https://navit.readthedocs.io/en/trunk/) pulled from the docs folder inside this repository<. + +We follow the [Documentation style guide from Sphinx](https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html) (as readthedocs uses sphinx). +With a small exception which is that we still use the `.rst` extension instead of the recommended `.txt` one for now. + +The [old wiki](https://wiki.navit-project.org/index.php) has been deprecated and is slowly being migrated to our +[new wiki](https://navit.readthedocs.io/en/trunk/). + +To update or add documentation, create a pull request on github using a PR title starting by `update:doc:` and followed by a +message explaining the change. + ## See also * [programming guidelines](https://navit.readthedocs.io/en/trunk/development/programming_guidelines.html) |