Skip to content
This repository has been archived by the owner on Mar 4, 2024. It is now read-only.

Add example workflow of usage with OE coax commutator. #12

Open
ChucklesOnGitHub opened this issue Mar 21, 2023 · 6 comments
Open

Add example workflow of usage with OE coax commutator. #12

ChucklesOnGitHub opened this issue Mar 21, 2023 · 6 comments
Assignees

Comments

@ChucklesOnGitHub
Copy link

Add example workflow of usage with OE coax commutator.

@cjsha
Copy link

cjsha commented Apr 3, 2023

in the form of a bonsai gallery?

@ChucklesOnGitHub
Copy link
Author

Also an examples folder. The idea would be to have the Bonsai examples:

  • linked in the documentation (done)
  • in an Examples folder in the repo
  • in a Bonsai gallery

@cjsha
Copy link

cjsha commented Apr 10, 2023

Is there a particular example workflow you want in the repo and as a Bonsai gallery? I suppose we should post all example workflows in the repo and as Bonsai galleries?

Also, the repo in question is the onix-commutator repo?

@ChucklesOnGitHub
Copy link
Author

What we had talked about with Jon was having an example folder in this repo, since it would be a specific set of examples for use with this package. The documentation already has workflows embedded for different applications.
I'm now wondering if this would be redundant. How are the bonsai example galleries handled? Are they downloaded with packages or separately?

I'm thinking: a user downloads the miniscope bonsai package to use the miniscope and goes to the package docs or gallery examples to see examples of how to use it. This might circumvent the commutator-docs and that's why we had discussed having them here.

@cjsha
Copy link

cjsha commented Apr 10, 2023

It seems that galleries are downloadable separately from packages and that downloading a gallery will also install all of its associated packages/dependencies.

@cjsha
Copy link

cjsha commented Apr 10, 2023

I think if the user circumvents the commutator-docs, more power to them. If they are able to get up-and-running without having to reference the docs, that's a win for the commutator's design. They'll probably consult the docs later down-the-line if they run into trouble. Does this sound reasonable or am I missing something?

Instead of having the workflows in this repo, we can link people (1) to the commutator-docs repo where are the workflows are available for download and (2) to the commutator documentation where there are instructions. What do you think? I'm just trying to avoid repetition which gets messy sometimes.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants