Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Hardware guide top levels should follow Breakout Board's example #199

Open
jonnew opened this issue Jan 30, 2025 · 2 comments
Open

Hardware guide top levels should follow Breakout Board's example #199

jonnew opened this issue Jan 30, 2025 · 2 comments
Assignees
Milestone

Comments

@jonnew
Copy link
Member

jonnew commented Jan 30, 2025

The top level in the Hardware Guides -> Breakout Board page looks like this:

Image

It has a linked bullet point list and image of hardware. The very next page is called Example Workflow and has the example bonsai workflow. I would like to follow this pattern for the other Hardware Guides. For instance, the NeuropixelsV1e:

Image

This should have an image of the device after the bullet point list and the workflow should be on the next page.

@cjsha
Copy link
Member

cjsha commented Feb 3, 2025

I agree and will work towards this, but I think it's worth commenting that we're starting to blurring the lines between the software docs and the hardware docs.

@jonnew
Copy link
Member Author

jonnew commented Feb 10, 2025

Plan of action after discussion:

  • We should move forward with this.
  • These pages should be simple and are there to link the hardware that people have physically to the operators that configure and stream data from the hardware. For instance, for NP1e headstage, we should ahve an image of the headstage with probe. The callouts should reference the two data data sources on those headstages (NP probe and BNO055) along with the oientation of the BNO.
  • An admonition, or similar, should provide a link to the complete hardware docs on each of these pages.

@jonnew jonnew added this to the 2025.02.17 milestone Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants