Reorg topic guides into categories and categorise dev guide sb - #8755
Conversation
wtbarnes
left a comment
There was a problem hiding this comment.
Overall I think this does improve the organization of the topic and dev guides. I'm a little worried that moving things to the dev guide makes them harder to find though.
| Data and Metadata | ||
| ******************** | ||
|
|
||
| These guides explain how SunPy represents observational data and the metadata associated with it. |
There was a problem hiding this comment.
With the guides we currently have, this is far from true, but I'm ok with it being aspirational.
There was a problem hiding this comment.
I'm a little worried that moving some of the "Extending SunPy" guides here reduces their visibility, but I see the logic from an organizational point of view.
There was a problem hiding this comment.
Yeah I guess my thinking here is that this is information you need when writing package code, either sunpy code or a sunpy plugin.
Rather than information you need when using sunpy.
When I looked at the existing topic guides in this PR, there was sort of this clear category of "extending sunpy" with new rotation methods and clients and stuff and it really didnt feel, to me, that this should be exposed to users at the same level as the other - more user focused things.
There was a problem hiding this comment.
Yeah I think it's worth putting them in the dev guide, it's noise to most people reading this.
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
| Getting started | ||
| ^^^^^^^^^^^^^^^ | ||
|
|
||
| .. toctree:: |
There was a problem hiding this comment.
I don't love this, it's going to get out of sync. I assume doing:
.. toctree::
getting_started
doesn't work?
There was a problem hiding this comment.
I don't know if that particular idea worked but i couldn't get a bunch of different ideas to work so I unleashed Claude and it couldn't get anything to work.
Either the index cards contained only top level categories and not the children or the sidebar did.
It's possible with another shot at it there is a solution out there cause I agree that it's not good defining it in two places
Claude tried something called "caption" in the toc tree too but that didn't work. Sidebar didn't populate at all.




AI tools were used for:
Ai was used to generate the new dev guide sidebar.