From 7c1f64c967e98432faaed5d6f11eddf055010066 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20L=C5=93uillet?= Date: Wed, 4 May 2016 14:42:14 +0200 Subject: Add documentation to know how to contribute to the documentation :trollface: --- docs/en/developer/documentation.rst | 12 ++++++++++++ docs/en/index.rst | 1 + 2 files changed, 13 insertions(+) create mode 100644 docs/en/developer/documentation.rst (limited to 'docs/en') diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst new file mode 100644 index 00000000..ab206479 --- /dev/null +++ b/docs/en/developer/documentation.rst @@ -0,0 +1,12 @@ +Contribute to this documentation +================================ + +Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs + +We use `ReadTheDocs +`__ to generate it. + +Pages are written in `Restructured Text +`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. + +If you create a new page, don't forget to edit the `index.rst `__ file to add a link in the sidebar. \ No newline at end of file diff --git a/docs/en/index.rst b/docs/en/index.rst index 6d2ce8f3..74e09f1a 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -46,5 +46,6 @@ The main documentation for this application is organized into a couple sections: developer/api developer/docker + developer/documentation developer/translate developer/maintenance -- cgit v1.2.3