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: [PATCH] Add documentation to know how to contribute to the documentation :trollface: --- docs/en/developer/documentation.rst | 12 ++++++++++++ docs/en/index.rst | 1 + docs/fr/developer/documentation.rst | 12 ++++++++++++ docs/fr/index.rst | 1 + 4 files changed, 26 insertions(+) create mode 100644 docs/en/developer/documentation.rst create mode 100644 docs/fr/developer/documentation.rst diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst new file mode 100644 index 000000000..ab2064799 --- /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 6d2ce8f31..74e09f1af 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 diff --git a/docs/fr/developer/documentation.rst b/docs/fr/developer/documentation.rst new file mode 100644 index 000000000..0fbe56268 --- /dev/null +++ b/docs/fr/developer/documentation.rst @@ -0,0 +1,12 @@ +Contribuer à cette documentation +================================ + +Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs + +Nous utilisons `ReadTheDocs +`__ pour la générer. + +Les pages sont écrites au format `Restructured Text +`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. + +Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst `__ pour ajouter un lien dans la barre latérale. \ No newline at end of file diff --git a/docs/fr/index.rst b/docs/fr/index.rst index afbacea0d..1e72dae78 100644 --- a/docs/fr/index.rst +++ b/docs/fr/index.rst @@ -47,5 +47,6 @@ La documentation principale de cette application est découpée en plusieurs sec developer/api developer/docker + developer/documentation developer/translate developer/maintenance