Bonsai Documentation

This repo contains the technical reference manual for the Bonsai visual programming language, in addition to articles and examples that document the collective knowledge of the Bonsai user community.

Note

This repo hosts the documentation for packages in the Bonsai standard library. Documentation for other Bonsai packages is hosted from each package repo.

Documentation is built using docfx, a static site generator that automatically generates API documentation for .NET projects, and deployed using GitHub Actions on GitHub Pages.

Contributing

Bonsai is a programming language with a growing community of users and developers. Anyone is welcome to participate by reporting bugs, proposing features or improvements, or contributing pull requests directly to our open-source repositories.

For more information please see our Contributor Guide. By contributing to our project, we also expect you to uphold our community Code of Conduct.

Quick start guide for contributing to documentation

These instructions apply to repos that already have a docfx website created.

1. Fork the repository you want to contribute documentation to.
2. Ensure that you are working off the main branch in your fork and create a descriptively named branch for each article/issue that you want to work on.
3. Download and install dotnet (https://dotnet.microsoft.com/en-us/download)
4. From a terminal window, restore docfx by running:

dotnet tool restore

5. Navigate to the directory where the file docfx.jsonis located and run the following command to generate a local preview of the documentation website as you are making changes.

dotnet docfx --serve

6. When you are ready to have your contribution reviewed, commit your edits to the appropriate branch of your fork and create a pull request to merge that branch with the main branch of the original repo.
7. Community maintainers will be assigned to review the PR and will conduct the final review and quality control check. If the contribution passes this final step, the PR to merge with main will be approved and the contribution will be published.

Check out the Documentation Style Guide for content formatting tips and the Documentation With Docfx article if you need help with docfx.