How to organize the Software Guide TOC

[cjsha]

I'm not sure how to make OpenEphys.Onix1 a first-class citizen in the same way that Bonsai.Onix was.

Previous discussion exists in PR #62

If we're happy how it is, we can leave it as is, but I wanted to open this issue in case anyone had any more ideas or comments regarding this concern.

[ChucklesOnGitHub]

The button is not cutting it for me, still thinking of alternatives.

1. Make "Go to the OpenEphys.Onix1 Docs" a heading so that it comes up in the right side bar, as another option for clicking. Under the heading I would specify that the software docs are in their own documentation site, for clarity.
2. Change the button so instead of the Bonsai logo it shows sth related to the library, or not have a button but a link.
3. See if we can nest an external link under "Bonsai ONIX Package". I don't fully understand the side-bars, but once I did see and external link coming up in there.

this is not about my taste, it's people going round in circles between hardware and software docs and getting confused. This is related to the sites needing separate but similar visual identities (as in open-ephys/bonsai-onix1-docs#15)

[ChucklesOnGitHub]

We discussed with @cjsha how to make the links to documentation more evident.

At the Software Guide page, provide the linkouts to the external documentation sites (bonsai.onix1 library docs and GUI docs)
These can be two buttons at the top, with a short text underneath them explaning the difference (borrowing from text in the subpages). Would the icons be of the applications or of the doc sites? We don't think we need subpages.

So then that leaves us with two other things that are hierarchically different: the oni-repl docs and the old library docs.

• can we unlist the oni-repl docs page? Otherwise it would be the only item in the TOC. Who would need to find it/look for it? Looks more like devs. We can do a section for Developers and link to it maybe
• can we unlist the old library docs? That way they don't show up in the TOC, but we can say "Looking for the deprecated Bonsai.ONIX docs?" and link to them.

[cjsha]

I think it's good practice for every page to belong to a table of contents especially so it can have proper breadcrumbs. I propose the toc keeps all four items that are currently there but the first two link out to external sites if possible. What do you think?