Add API TOC categories template #7
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
From open-ephys/bonsai-onix1-docs@c2e0bd4 Co-authored-by: Cris <[email protected]> Co-authored-by: Brandon Parks <[email protected]>
Refactor defineSubOperators function into new BonsaiCommon.js file so it can be used by ManagedReference and TOC templates Modify TOC logic and categories in toc.extension.js
- Add Transforms identification logic to defineOperatorType function in BonsaiCommon.js - Strip OE operator specific code from defineOperatorType - Add in unique Bonsai combinators, sinks and transform that were missing from defineOperatorType - Update TOC categories in toc extension.js
Co-authored-by: Cris <[email protected]>
- as this file ended up only containing one function, it was removed and the function integrated into toc.extension.js
Draft
|
Changing to draft to work on feedback from DCM. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #6 by sorting API nodes in the TOC into standard Bonsai Workflow categories.
See README for usage instructions.
Note: When I tested it in my local preview just having bonsai/template wasn't enough (unintuitive and not sure it is supposed to work that way) but it may be for the best since bonsai/template currently contains the workflow container css/js template and some packages might want to import only that and not the API TOC template.
An online preview of this PR can be seen at: https://banchan86.github.io/machinelearning_docs/api/Bonsai.ML.LinearDynamicalSystems.html
Edit: As I'm looking at it I also realised the namespace page should reflect the TOC grouping, will work on that too.