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 markup language and then compiled into a static website/offline document using the open-source Sphinx and ReadTheDocs tools.
You may also want to refer to the GenPipes New Documentation Architecture Map 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 and open issues with the following label:
documentationThank you for your valuable inputs.
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 GenPipes documentation map 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 Writing style 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.