mirror of
https://github.com/wallabag/wallabag.git
synced 2024-12-24 16:40:30 +00:00
Add documentation to know how to contribute to the documentation :trollface:
This commit is contained in:
parent
8b563fc04e
commit
7c1f64c967
4 changed files with 26 additions and 0 deletions
12
docs/en/developer/documentation.rst
Normal file
12
docs/en/developer/documentation.rst
Normal file
|
@ -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
|
||||
<https://readthedocs.org>`__ to generate it.
|
||||
|
||||
Pages are written in `Restructured Text
|
||||
<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.
|
||||
|
||||
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.
|
|
@ -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
|
||||
|
|
12
docs/fr/developer/documentation.rst
Normal file
12
docs/fr/developer/documentation.rst
Normal file
|
@ -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
|
||||
<https://readthedocs.org>`__ pour la générer.
|
||||
|
||||
Les pages sont écrites au format `Restructured Text
|
||||
<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.
|
||||
|
||||
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.
|
|
@ -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
|
||||
|
|
Loading…
Reference in a new issue