Contribute to Documentation¶
Most of the work on the Hypha User Guide takes place on the project’s GitHub repository. To get started, check out the list of open issues and pull requests. By contributing to the Hypha User Guide, you’re expected to follow the Code of Conduct.
The Hypha Guide welcomes contributors! There are lots of ways to help out, including:
- Reading the guide and giving feedback
- Reviewing new contributions
- Revising existing content
- Writing new content
- Translate the guide
This project consists of several distinct documentation types with specific purposes, inspired by a documentation framework called Diátaxis. When proposing new additions to the project please pick the appropriate documentation type.
Provides step-by-step instructions on how to set up a local instance of Hypha.
Write technical documentation with a new developer in mind. Create a quickstart doc wherever possible. What is the bare minimum information that a user needs to get started with the feature that you are documenting? Start there.
Guides are focused on accomplishing a specific task and can assume some level of prerequisite knowledge. There may be multiple approaches to accomplishing a task, and we welcome your input.
Discussions are focused on understanding and information exchange. These explore a specific topic without a specific goal in mind. https://we.hypha.app/