open-ephys / bonsai-onix1-docs

Documentation for the OpenEphys.Onix1 Bonsai package
https://open-ephys.github.io/bonsai-onix1-docs/
Creative Commons Attribution Share Alike 4.0 International
0 stars 2 forks source link

Move hardware tutorial under user guide #58

Closed cjsha closed 1 month ago

cjsha commented 2 months ago

@bparks13, commit 6801090 didn't pass linkcheck, but I believe it's just a matter of removing the #editing-operator-properties bookmark in an <a> tag in partials/hubs/device.tmpl.partial if there's no way to keep the reference to that header while passing linkchecks. I would further investigate this myself, but I really can't work on this anymore until I get back. Thanks.

bparks13 commented 2 months ago

@cjsha Regarding the invalid bookmark issue, there are a couple ways we can move forward. The one that I think makes the most sense is to override the severity level of the message in the docfx.json file, so that this particular message is now a "Suggestion". Then, we can slightly modify the utility script to print Suggestions, but to not mark it as an error. This way the error is printed out in the console for the developer to read it, but it will not stop the CI build. If this bookmark is then not linked correctly after building, DocLinkChecker/Lychee will check the HTML pages and throw an error, so it will still be caught if the bookmark is truly invalid and would lead to a broken link.

cjsha commented 2 months ago

@bparks13 I think that's a good solution, I would feel comfortable if we move forward with that

jonnew commented 1 month ago

I'm moving on to another project tomorrow. @bparks13 and @cjsha , please perform a final review of this guide. Its very possible i screwed up formatting and links, especially since the templates make editing things very non-local. Edits and additions are fine and should be done at your discretion. However, lets not engage in a discussion on the merits of the content I've added. We need to move on to other things.