Contributors to the documentation can be project managers, technical editors, developers, and end-users. We welcome all contributions that help improve our documentation.
To ensure our documentation stays resilient and up-to-date, we employ the use of the open practice of Docs As Code and the open Markdown format for ease of collaboration and quality control.
To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the Standard for Public Code, a framework maintained by the Foundation for Public Code.
<br>
<br>
- Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and rename it to README.md, replacing the Quick start guide for this template with your projects information.
- Follow the criteria from Document the Code, Document your codebase objectives and Document codebase Maturity in one or several text documents using the Markdown format.
- Document further suggestions and improvements by raising issues and describing what needs to be fixed, describe the user stories and potential delivered values.
- Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an assignee to the issue.
- Collaborate on documentation branches with issues assigned to you by the maintainers.
📚 Read more about:
How to use Markdown to collaborate on documentation How Just the Docs is used to generate a documentation site from your markdown files.