CAPIBARA Collaboration Documentation

Welcome to the official documentation hub of the CAPIBARA Collaboration.
Here you will find:

• Public documentation — project overviews, onboarding tutorials, software guides, governance policies.

• Internal documents — collaboration-only materials such as meeting notes, agreements, and private templates.

• Reusable templates — project templates, proposal forms, analysis note structures, meeting-minute templates, etc.

Use the navigation tree below to browse the major sections of the documentation.

---

• Governance
• Onboarding
• Templates
• Sitemap for Documentation

Return to the main page.

A Documentation for Documentation

1. What is this?

This part of the website (capibara3.githubio/docs) hosts the documentation files for the CAPIBARA Collaboration, from onboarding tutorials, to software guides as well as organisation and policies. We make all of our files, including organisation and legal ones, open except for signed agreements and documents containing personal data due to privacy protection.

2. How to use?

You can consult the structure of the documentation at capibara3.github.io/docs/sitemap. On the left-handed menu you can see the pages contained in your current directory, while in the right-handed one the section of your current page are displayed. On top there is a menu and a search tab which lets you find relevant pages by keywords. We try to maintain links updated, but since docs are always evolving it can happen that some paths become broken.

3. Report bugs

If you spot mistakes of any type (typos, content-wise, missing information, website production, …) you should communicate these to us, so that we can apply the necessary corrections. Proceed to click on the bug button in the navigation bar (top right) and create an issue to inform us. In all cases when communicating bugs and errors, please provide clear and detailed explanations with links to the relevant pages, you may include screenshots or other supporting documentation to help understanding. We will try to get back to you to solve the problem. We appreciate your help.

If you are a member, you can open an issue directly at capibara3.github.io/.github-private (where our documentation source is) and/or read the next section to know how to submit a PR.

4. Contribute

All members are invited to contribute to the enhancing of the documentation, both guides and tutorials as well as legal documents and policies. We are all part of this so we want to make our tutorials more accessible to unexperienced members and policies adapted to our collaboration and status, although the ammendment of policies is regulated and can only happen by majority.

Our documentation live in the .github-private repository, where only collaboration members can access both the public and internal markdown files. These are the files that need to be edited. Then with GitHub Actions, we use Sphinx and pydata-sphinx-theme to automatically generate HTML pages from these docs and push the public files to our website repository (capibara3/capibara3.github.io). Afterwards, the website is uploaded and published but this a different process.

To contribute to our docs you must fork and/or create a new branch in the capibara3/.github-private repository and later on create a PR for discussion and merging of your changes. Please, make sure to wait for review, comments and suggestions before merging your edits.