Add documentation to know how to contribute to the documentation :trollface:

diff --git a/docs/en/developer/documentation.rst b/docs/en/developer/documentation.rst
new file mode 100644 (file)
index 0000000..ab20647
--- /dev/null
+++ b/docs/en/developer/documentation.rst
@@ -0,0 +1,12 @@
+Contribute to this documentation\r
+================================\r
+\r
+Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs\r
+\r
+We use `ReadTheDocs\r
+<https://readthedocs.org>`__ to generate it.\r
+\r
+Pages are written in `Restructured Text\r
+<https://en.wikipedia.org/wiki/ReStructuredText>`__ format. You can use online tools like http://rst.aaroniles.net/ or http://rst.ninjs.org/ to preview your articles. \r
+\r
+If you create a new page, don't forget to edit the `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/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 6d2ce8f31c95fae27f4511fefc527449d177b9e6..74e09f1afa57195121da7a81aea8075e139aedb7 100644 (file)
--- 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 (file)
index 0000000..0fbe562
--- /dev/null
+++ b/docs/fr/developer/documentation.rst
@@ -0,0 +1,12 @@
+Contribuer à cette documentation\r
+================================\r
+\r
+Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs\r
+\r
+Nous utilisons `ReadTheDocs\r
+<https://readthedocs.org>`__ pour la générer.\r
+\r
+Les pages sont écrites au format `Restructured Text\r
+<https://fr.wikipedia.org/wiki/ReStructuredText>`__. Vous pouvez utiliser des outils en ligne comme http://rst.aaroniles.net/ ou http://rst.ninjs.org/ pour prévisualiser vos articles. \r
+\r
+Si vous créez une nouvelle page, n'oubliez pas d'éditer le fichier `index.rst <https://raw.githubusercontent.com/wallabag/wallabag/master/docs/en/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 afbacea0dc0ccb75ca9b3509c5f5aaf4691c696d..1e72dae782089f1ecd72cd7f72bba0acee83f7f7 100644 (file)
--- 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