-
Notifications
You must be signed in to change notification settings - Fork 12
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Description
Converted this into a meta issue for documentation updates for Bonsai 2.9 as I realized that there was more stuff to be updated. Will list checklists for stuff to update, issues/PRs as they are being raised and notes as I go along.
Articles
- Package Manger
- Workflow Editor
- Bonsai Gallery
- Add notice for missing gallery content in Bonsai 2.9 #144
- Disabling the article is an option, but the gallery examples are still present in older versions which point to the myget community package feed.
- In the future, once we have settled on an established workflow for publishing examples then we can also document that process here.
- Add notice for missing gallery content in Bonsai 2.9 #144
- Environments
- Update "Environments" article for Bonsai 2.9 #145
- Document creating a new
.bonsaienvironment from workflow folders #142 once issues with initializing from workflow folders have been fixed.
- Document creating a new
- Update "Environments" article for Bonsai 2.9 #145
- Property Mapping
- Update editor screenshot
- Visualizer Mapping (new article)
- Add article on type visualizers and visualizer composition #80
- Also explain the new
VisualizerWindow
- Higher Order Operators
- Update editor screenshot
- Command Line Interface
- Document creating a new
.bonsaienvironment from workflow folders #142- Will require more extensive modifications when the command line interface is revamped.
- Document creating a new
- Scripting Extensions
- Creating a Package
- Documentation with docfx
- Might be unnecessary if people use the bonsaidocs template, and we can subsume a basic section under that article (how to to serve the docfx preview for instance).
- Documentation With Docfx aritcle should be marked as temporarily out of date #140
- Documentation requiring refresh prefect#1
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation