Welcome to the official documentation hub of the CAPIBARA Collaboration. Here you will find collaboration wide resources such as onboarding and coding tutorials, governance policies, and other important pages.

Use the navigation sidebar to the left to browse the documentation. You can also see a graph view and the table of contents of the current page in the right sidebar. Pressing Cmd/Ctrl + K allows you to search pages.

Return to the CAPIBARA Collaboration main webpage here.

General Documentation Guide

1. What is this?

This part of the website (capibara3.github.io/docs) hosts the documentation files for the CAPIBARA Collaboration, including onboarding tutorials, software guide, organizational structure, policies and other information pages. We make all of our file publicly available including organizational and ‘internal’ documents, as far as personal data and official signed documents allow (for privacy protection). While our GitHub serves as a communication hub (discussions and chat features), code and file storage (repositories) including documentation files in each repository, in this documentation we share general inter-repository and collaboration-wide documentation.

2. How to navigate

In the left sidebar, you can browse the files, while in the right sidebar shows a graph view to recognise links between pages and the table of contents of the current page. In the top left corner you can find the homepage link, a search function, which can also be toggled with Ctrl/Cmd+K, and the light/dark mode button. We update links regularly, but as documentation evolves some paths may be temporarily broken.

3. Report issues

If you spot any mistakes like typos, incorrect content, missing information, website bugs, broken links, etc., please let us know so we can make corrections. At the bottom of any page you will find a “Report Bug” button. When reporting problems, please provide clear explanations with

• Links to relevant pages
• Screenshots or supporting documentation
• Specific details about the issue

We appreciate your help and will work to resolve the problem promptly.

If you are a member, you can open an issue directly at the capibara3/.github-private repository (where our documentation source lives) or read the next section to learn how to submit a pull request.

4. How to contribute

All members are invited to contribute to improving the documentation, including guides, tutorials, governance documents, and policies. We want to make our tutorials accessible to inexperienced members and keep our policies adapted to our collaboration’s needs. Note that policy amendments are regulated and require majority approval.

Our documentation lives in the .github-private repository, where only collaboration members can access both public and internal markdown files. These are the files (.github-private/docs/content/) which are to be edited. To contribute to our documentation you should:

1. Clone the repository
2. Create a new branch
3. Make your changes
4. Create a pull request for discussion
5. Wait for review and approval before merging.

Please ensure your edits are discussed and approved before merging with the main branch.