Structure revamp and new fw capabilities updates#59
Conversation
|
|
There was a problem hiding this comment.
do we need a banner informing people that the most recent version of the software supports the most recent version of the daq firmware?
beyond the scope of this PR, but we need to go through and clear up the formatting to make these docs easier to read. For example:
I think the tutorials need to be updated for the new version of the library?
I almost feel like the User Guide can fall under FAQ. For example, there can be a few questions "How do I plan ahead for miniscope surgery?" "Are there resources to learn how to do surgery?" "How do I habituate animals?" etc. If you agree, the User Guide can just be subsumed by the FAQ. I just think that there are too many guides between the software guide in the hardware guide and the user guide on the front page
|
Corraling outstanding ToDos:
Addressing some other comments:
|
|
In my local build some of the workflow images are cropped, would you know @cjsha why this could be? e.g. Software-Guide/trigger
|
Sorry I think you're right. I think the part that might require updating is about syncing data. We should mention the |
|
I think my qualm with the user guide is that the software guide feels like the real user guide and the user guide feels more like "extra information". |
not sure how this happened but it's because the images themselves are cropped.
|
- no wrapping on bonsai workflow titles - fix video references - a couple minor edits
…cope-docs into issue-45-denest
to accommodate slow chroma websites. increased from 5 seconds to 20
cjsha
left a comment
There was a problem hiding this comment.
I submitted my feedback and made some changes to the docs in their current state. I understand that more changes are to come before this is fully merged, but I feel comfortable for you to take care of that stuff without another round of review if you feel that way too. so I will approve this PR already. with that said, lmk if you want me to look at anything
try to decrease chroma load time
references to chroma.com were causing timeout failures. I removed linkcheck timeout and request headers for chroma.com.
|
additional changes that need to be made:
|
|
Remaining items:
|



Fixes #45
Fixes #58
Fixes #55
Fixes #52
Fixes #48
Fixes #40
Fixes #26