Public documentation for the OpenBoxes application.
Documentation containing instructions, standards, and background information for technical and non-technical contributors to the OpenBoxes community.
Live at: https://openboxes.gitbook.io/contributor-guide/
Built using GitBook. Synchronized with the files in the ./contributor-guide folder.
If you'd like to add to or modify the documentation in this guide, please create a new branch or fork the repository and directly modify the relevant markdown (.md) files there. Then make a pull request from your branch into the main branch of this repository. We'll try to review your change promptly.
If you're a regular contributor to our documentation, you can request to be added to the OpenBoxes GitBook project where you'll be able to edit the documentation using the GitBook GUI, which is more user-friendly than editing markdown files. For access, please send an email to [email protected].
The following is a list of other OpenBoxes documentation that is managed outside of this repository:
- Admin Guide (MkDocs): Technical instructions for installing, updating, configuring and deploying the application. The docs live in the ./docs folder of the main openboxes repository.
- User Guide (helpscout): Non-technical instructions for how to use specific features in the app.
- OpenBoxes Wiki (Confluence): Additional non-technical feature instructions.