diff options
| author | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-05-04 14:42:14 +0200 |
|---|---|---|
| committer | Nicolas Lœuillet <nicolas@loeuillet.org> | 2016-05-04 14:42:14 +0200 |
| commit | 7c1f64c967e98432faaed5d6f11eddf055010066 (patch) | |
| tree | f0423e3eeab50268bc0a148903415fe04069fcbb /docs | |
| parent | 8b563fc04ee5ab6adc8370bdaf7f8a5b50f14f95 (diff) | |
| download | wallabag-7c1f64c967e98432faaed5d6f11eddf055010066.tar.gz wallabag-7c1f64c967e98432faaed5d6f11eddf055010066.tar.zst wallabag-7c1f64c967e98432faaed5d6f11eddf055010066.zip | |
Add documentation to know how to contribute to the documentation :trollface:
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/developer/documentation.rst | 12 | ||||
| -rw-r--r-- | docs/en/index.rst | 1 | ||||
| -rw-r--r-- | docs/fr/developer/documentation.rst | 12 | ||||
| -rw-r--r-- | docs/fr/index.rst | 1 |
4 files changed, 26 insertions, 0 deletions
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 @@ | |||
| 1 | Contribute to this documentation | ||
| 2 | ================================ | ||
| 3 | |||
| 4 | Sources of our documentation are here https://github.com/wallabag/wallabag/tree/master/docs | ||
| 5 | |||
| 6 | We use `ReadTheDocs | ||
| 7 | <https://readthedocs.org>`__ to generate it. | ||
| 8 | |||
| 9 | Pages are written in `Restructured Text | ||
| 10 | <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. | ||
| 11 | |||
| 12 | 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 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: | |||
| 46 | 46 | ||
| 47 | developer/api | 47 | developer/api |
| 48 | developer/docker | 48 | developer/docker |
| 49 | developer/documentation | ||
| 49 | developer/translate | 50 | developer/translate |
| 50 | developer/maintenance | 51 | developer/maintenance |
diff --git a/docs/fr/developer/documentation.rst b/docs/fr/developer/documentation.rst new file mode 100644 index 00000000..0fbe5626 --- /dev/null +++ b/docs/fr/developer/documentation.rst | |||
| @@ -0,0 +1,12 @@ | |||
| 1 | Contribuer à cette documentation | ||
| 2 | ================================ | ||
| 3 | |||
| 4 | Les sources de notre documentation sont ici https://github.com/wallabag/wallabag/tree/master/docs | ||
| 5 | |||
| 6 | Nous utilisons `ReadTheDocs | ||
| 7 | <https://readthedocs.org>`__ pour la générer. | ||
| 8 | |||
| 9 | Les pages sont écrites au format `Restructured Text | ||
| 10 | <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. | ||
| 11 | |||
| 12 | 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 afbacea0..1e72dae7 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 | |||
| 47 | 47 | ||
| 48 | developer/api | 48 | developer/api |
| 49 | developer/docker | 49 | developer/docker |
| 50 | developer/documentation | ||
| 50 | developer/translate | 51 | developer/translate |
| 51 | developer/maintenance | 52 | developer/maintenance |