Move hardware tutorial under user guide #58
Conversation
- This change implements breakout tutorial only - This provides scaffolding for other hardware tutorials (np ones are mostly written, they need to be restructured & moved over from another)
|
@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. |
|
@bparks13 I think that's a good solution, I would feel comfortable if we move forward with that |
- Changed log severity from warning to suggestion - Added `Devices` property category - Capitalized sentence start
- Use more original breakout board content from jon - Write like a human - Better flow throughout and across pages - Parahraphs instead of bullet points - Breakout board schematic - workflow has its own page so it can be at the top of page - add real-world content
bparks13
left a comment
bparks13
left a comment
There was a problem hiding this comment.
Some preliminary comments that I noticed. This is not a full review.
Note: All BreakoutDigitalInput / BreakoutDigitalOutput needs to be corrected to be DigitalInput / DigitalOutput to match the main library as of open-ephys/bonsai-onix1#301.
- new operators were added which requires new workflows - The operators containing "Breakout" (except BreakoutBoard) were obsoleted so workflows were changed to use the new renamed operators
- Updated submodule to point to the v0.3.0 tag for the main library - Cleaned up old files that should have been deleted - Added new Bonsai workflows that are expected to be there from new operators in 0.3.0 - Miscellaneous spelling / grammar fixes
bparks13
left a comment
bparks13
left a comment
There was a problem hiding this comment.
I think this is good how it is, this provides a much needed update to the website in that it correctly reflects the current status of the main repo. Fixes a number of broken links, and will allow us to push the new version of the website again.
- Need thorough read-through
|
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. |
@bparks13, commit 6801090 didn't pass linkcheck, but I believe it's just a matter of removing the
#editing-operator-propertiesbookmark in an<a>tag inpartials/hubs/device.tmpl.partialif 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.