Skip to content

Reorg topic guides into categories and categorise dev guide sb - #8755

Merged
alasdairwilson merged 5 commits into
sunpy:mainfrom
alasdairwilson:reorg-topic-guides
Aug 20, 2026
Merged

Reorg topic guides into categories and categorise dev guide sb#8755
alasdairwilson merged 5 commits into
sunpy:mainfrom
alasdairwilson:reorg-topic-guides

Conversation

@alasdairwilson

Copy link
Copy Markdown
Member
  • tidied the topic guides into coordinates, data/metadata, and configuration sections.
  • Moved the properly developer-y stuff: Fido extensions, Map classes, scraper migration, deprecations, into the dev guide.
  • Split the Developer’s Guide sidebar into expandable groups that match the index cards, I used AI for this because annoyingly I couldn't get it to be a single configuration where i could define both the index cards and the sidebar in one place. AI failed here as well though luckily

AI tools were used for:

  • Documentation (including examples)

Ai was used to generate the new dev guide sidebar.

@alasdairwilson

alasdairwilson commented Aug 18, 2026

Copy link
Copy Markdown
Member Author

New dev guide sidebar:

image

versus:

image

New topic guide sidebar:

image

versus:

image

@wtbarnes wtbarnes left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the guides we currently have, this is far from true, but I'm ok with it being aspirational.

Comment thread docs/dev_guide/index.rst

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think it's worth putting them in the dev guide, it's noise to most people reading this.

Comment thread docs/dev_guide/index.rst Outdated
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
Comment thread docs/dev_guide/index.rst
Getting started
^^^^^^^^^^^^^^^

.. toctree::

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't love this, it's going to get out of sync. I assume doing:

.. toctree::

  getting_started

doesn't work?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@Cadair Cadair left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me

@alasdairwilson
alasdairwilson merged commit d0910b4 into sunpy:main Aug 20, 2026
42 of 45 checks passed
@alasdairwilson
alasdairwilson deleted the reorg-topic-guides branch August 20, 2026 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants