https://github.com/bonsai-rx/docs
Documentation, technical reference manual, and examples for the Bonsai visual programming language
Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 6 committers (16.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.5%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Documentation, technical reference manual, and examples for the Bonsai visual programming language
Basic Info
- Host: GitHub
- Owner: bonsai-rx
- License: cc-by-sa-4.0
- Language: HTML
- Default Branch: main
- Homepage: https://bonsai-rx.org/docs/
- Size: 5.24 MB
Statistics
- Stars: 2
- Watchers: 4
- Forks: 11
- Open Issues: 33
- Releases: 0
Topics
Metadata Files
README.md
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.
- Fork the repository you want to contribute documentation to.
- Ensure that you are working off the
mainbranch in your fork and create a descriptively named branch for each article/issue that you want to work on. - Download and install dotnet (https://dotnet.microsoft.com/en-us/download)
- From a terminal window, restore
docfxby running:powershell dotnet tool restore - 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.powershell dotnet docfx --serve - 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
mainbranch of the original repo. - 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
mainwill 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.
Owner
- Name: Bonsai
- Login: bonsai-rx
- Kind: organization
- Website: bonsai-rx.org
- Repositories: 13
- Profile: https://github.com/bonsai-rx
A visual language for reactive programming
GitHub Events
Total
- Issues event: 41
- Delete event: 5
- Issue comment event: 49
- Push event: 24
- Pull request event: 42
- Pull request review comment event: 41
- Pull request review event: 57
- Fork event: 1
- Create event: 6
Last Year
- Issues event: 41
- Delete event: 5
- Issue comment event: 49
- Push event: 24
- Pull request event: 42
- Pull request review comment event: 41
- Pull request review event: 57
- Fork event: 1
- Create event: 6
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| glopesdev | g****v | 194 |
| Shawn Tan | b****n@g****m | 67 |
| taunsquared | d****e@a****u | 20 |
| David Maas | d****t@n****g | 5 |
| github-actions[bot] | g****] | 3 |
| brunocruz | b****z@g****m | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 19
- Total pull requests: 26
- Average time to close issues: 3 months
- Average time to close pull requests: 4 months
- Total issue authors: 5
- Total pull request authors: 5
- Average comments per issue: 0.05
- Average comments per pull request: 0.38
- Merged pull requests: 13
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 16
- Pull requests: 21
- Average time to close issues: 3 months
- Average time to close pull requests: 15 days
- Issue authors: 2
- Pull request authors: 3
- Average comments per issue: 0.06
- Average comments per pull request: 0.33
- Merged pull requests: 12
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- banchan86 (23)
- taunsquared (8)
- glopesdev (2)
- bparks13 (1)
- PathogenDavid (1)
- jackiekuyat (1)
- cjsha (1)
- bruno-f-cruz (1)
Pull Request Authors
- banchan86 (21)
- glopesdev (10)
- PathogenDavid (3)
- RoboDoig (1)
- taunsquared (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- actions/checkout v2 composite
- crazy-max/ghaction-chocolatey v1 composite
- microsoft/setup-msbuild v1 composite
- peaceiris/actions-gh-pages v3 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite