.. _docs_documentation_about:


About Docs
==========

This GenPipes documentation is continuously written, corrected, edited, and revamped by
members of the GenPipes community. 

It is edited via text files in the
`reStructuredText <http://www.sphinx-doc.org/en/stable/rest.html>`_ markup
language and then compiled into a static website/offline document using the
open-source `Sphinx <http://www.sphinx-doc.org>`_ and `ReadTheDocs
<https://readthedocs.org/>`_ tools.

You may also want to refer to the :ref:`GenPipes New Documentation Architecture Map<docs_genpipes_archmap>` for more insights on how GenPipes documentation is organized.

Feedback
--------

User feedback is valuable to us.

For any documentation feedback, queries or any issues, please refer to `GenPipes Documentation Project <https://github.com/c3g/GenPipes_Docs>`_ and open issues with the following label:

.. raw:: html

   <span style="background-color: #FFFF00">
   documentation
   </br>
   </br>
   </span>

*Thank you for your valuable inputs.*

.. _ref_docs_contrib_guidelines:

.. note:: You can contribute to GenPipes documentation.
          
Contribution Guidelines
------------------------

We are happy to receive your contributions to GenPipes documentation!

Before you begin to make edits to GenPipes documentation, we would strongly recommend that you discuss and share your plans through a GitHub issue with the GenPipes documentation owner(s), especially for more ambitious contributions. 

Here are some guidelines to contribute to GenPipes documentation:

* Fork the repository, deploy Sphinx and its dependencies.
* Familiarize yourself with the organization and structure of GenPipes documentation in terms of information architecture. Refer to the :ref:`GenPipes documentation map<docs_genpipes_archmap>` to understand how the content sources are organized. Get familiar with the TOC and information flow. 
* Use references within the text instead of duplicating information.  Use search feature to identify the keyword and their mapping in the TOC. 
* Follow the GenPipes :ref:`Writing style guidelines<doc_gp_writing_guidelines>` while adding or updating content into GenPipes documentation.
* Before you delete any content, make sure it is not relevant in some user context.
* Make sure, any content you add is targeted and tailored to the needs of GenPipes audience - new users or seasoned GenPipes users. 

References
-----------

* Using Sphinx and ReadTheDocs for building documentation of Python projects - a very informative `reference <https://brendanhasz.github.io/2019/01/05/sphinx.html>`_.