X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=CONTRIBUTING.md;h=bb82951d61abc12b9bbbc4d1eaf28d55e597303b;hb=70cb883547a04b3ccd3fda567d15541d124a3f41;hp=3646408f8ec51b54fef754cac4e2c91436b6494f;hpb=5b25a9635fe808bc1c4f3eee8cdf8485115da75d;p=github%2Fshaarli%2FShaarli.git diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3646408f..bb82951d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ Check the [milestones](https://github.com/shaarli/Shaarli/milestones) to see wha ### Documentation -The [official documentation](http://shaarli.readthedocs.io/en/rtfd/) https://github.com/shaarli/Shaarli/wiki) is generated from [Markdown](https://daringfireball.net/projects/markdown/syntax) documents in the `doc/md/` directory. HTML documentation is generated using [Mkdocs](http://www.mkdocs.org/). [Read the Docs](https://readthedocs.org/) provides hosting for the online documentation. +The [official documentation](http://shaarli.readthedocs.io/en/rtfd/) is generated from [Markdown](https://daringfireball.net/projects/markdown/syntax) documents in the `doc/md/` directory. HTML documentation is generated using [Mkdocs](http://www.mkdocs.org/). [Read the Docs](https://readthedocs.org/) provides hosting for the online documentation. To edit the documentation, please edit the appropriate `doc/md/*.md` files (and optionally `make htmlpages` to preview changes to HTML files). Then submit your changes as a Pull Request. Have a look at the MkDocs documentation and configuration file `mkdocs.yml` if you need to add/remove/rename/reorder pages.