Beagle v1.6 is no longer actively maintained. The documented version you are viewing may contain deprecated functionality. For up-to-date documentation, see the latest version .
We use the tool Hugo to create static sites, which is ideal for documentation, and all the docs content is written in markdown.
If you have any difficulty with this syntax, you can access this basic guide.
All contributions are welcome, but to get starting contributing to Beagle it is good to have in mind these recommendations:
To edit content, simply navigate to the page to be edited using the left side menu or the search field. Then click on the “Edit this page” button, located on the right side menu.
Once this is done, you will be redirected to the source file hosted on github in edit mode. Okay, now just edit the file. Then, open a pull request using the github website, filling out the form as shown in the image below:
Images in this documentation are saved at a folder called shared at
/static/shared. To add new images to the doc just copy them into this folder. From there, all images are accessible from any page or sub-page in the documentation.
To load images on a page use the markdown interface for images (without adding a title) and list the address as
/shared/image-name as follows:
To help us identify problems in general, be it styling, reading, organizing or code architecture of the documentation, just open an issue using the “Create a documentation issue” button located on the right side menu of the page.
Then you will be redirected to a github page with a label and a pre-established standard template for opening an issue, but feel free to edit the suggested template and propose the changes that make the most sense for your contribution.
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.