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

Reorganize software guide #87

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Reorganize software guide #87

wants to merge 14 commits into from

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Feb 3, 2025

  • Add sphinx-design
  • Add cards on front page
  • Delete extraneous page
  • GUI card & TOC entry will link to an external page once that page exists in the gui-docs site
  • Cards still need images

- Add sphinx-design
- Add cards on front page
- Delete extraneous page
- GUI card & TOC entry will link to an external page  once that page exists in the gui-docs site
- Cards still need images
@cjsha cjsha marked this pull request as ready for review February 3, 2025 18:21
@ChucklesOnGitHub
Copy link
Member

ChucklesOnGitHub commented Mar 3, 2025

image

I've taken some poetic license here, but bear with me. You had tied each button to the application instead of the package/plugin and I think this works really nicely for users, as opposed to using the name of the package or plugin. We can go into the details in the corresponding pages. I tried to keep the same hierarchical structure for everything: mention application then package/plugin , so they may not be 100% gramatically correct. I also avoided colons in the card titles.

In line with this, I've referenced the application in the navigation because Bonsai package is more relatable than its formal name.
I also titled the section about the old library Deprecated Software, following the title it had in the section landing page, to avoid the "Bonsai" in Bonsai.ONIX to jump out. I think this works nicely.

GUI card & TOC entry will link to an external page once that page exists in the gui-docs site

While this would keep the click-out hierarchy the same as Bonsai so for me it makes sense, I think the content from the current index.rst in the GUI plugin section should be reflected in the Software Guide section, because the two applications will not provide the same system functionality (OE GUI is not for imaging data, not for stimulation, etc - or is it).

Cards still need images

I think referring to the package/plugin by the application logo works.

Copy link
Member

@ChucklesOnGitHub ChucklesOnGitHub left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cjsha take a look

- make card titles one line by widening cards
- replace bullet point at bottom with regular sentence
- "There are various software to acquire data" --> "There are two recommended software programs to acquire data"
@cjsha cjsha deployed to Testing March 7, 2025 03:41 — with GitHub Actions Active
@cjsha cjsha requested a review from jonnew March 7, 2025 03:42
@cjsha
Copy link
Member Author

cjsha commented Mar 7, 2025

@jonnew This PR is supposed to make navigating to the software docs from the hardware docs easier. I tagged you for review because I know you worked on this previously and so I don't want to change these pages without your acknowledgement.

image

The first card and first toc entry link to bonsai-onix1-docs
The second card and second toc entry link to this placeholder page until there is a page for the onix-source plugin in the gui-docs

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

Successfully merging this pull request may close these issues.

2 participants