feat: build documentation for diagrams#183
Conversation
|
I think something needs to be tweaked, the built version (in the PR comment link) for me doesn't seem to show any of the diagrams? 
|
The diagrams/index.md toctree referenced high_level, mid_level, low_level, and dynamic_foraging, but those pages were never tracked, so the published build showed the landing header with no diagrams. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
@dbirman - Try now |
dbirman
left a comment
dbirman
left a comment
There was a problem hiding this comment.
Currently these seem mostly like reference material, since they are disconnected from the how-to guides where we have most of our docs content. I think that's okay, but I feel like they would be much more useful embedded alongside the relevant content related to each diagram. They don't need to be in-line, they could appear as hover tooltips or something, or link from that content to a page with each of the diagrams.
At a minimum it would be good to provide a text description of each diagram, and probably use the glossary system that Tom set up for definitions of systems that a user might not know in advance.
I think also in an effort to reduce clutter on the left sidebar we should put this under the AIND Resources section, and probably just rename that "Resources". I will revisit the sidebar in the future though to reduce the number of things there, so not necessary to do that now.
Yeah - this fits. I will add some documentation and put them under the Resources section |
2 participants
📚 Documentation preview 📚: https://scicomp-docs--183.org.readthedocs.build/en/183/