[erikvansebille]

Description

This PR changes the user guide in the documentation to a nested structure, so that the sidebar only shows the main sections by default. This helps users get an overview of the entire documentation - otherwise the list of pages would be much longer than the left sidebar

As I was reorganising the user-guide layout, I also implemented #2966 to flatten the file-structure of the user-guide.

The new layout looks like the screenshot below

Checklist

• Closes Flatten tutorial file-structure #2966
• This PR targets the correct branch (main for normal development, v3-support for v3 support)

AI Disclosure

N/A

[VeckoTheGecko]

Looks good. Here's some review feedback.

I have also reached out to the Scientific Python community about how they handle moving pages arounds (perhaps we can have automatic redirects to prevent broken URLs from doing #2966 ) .

If its easy to redirect pages, I think that would be great (I think people might be confused running into 404s, and won't take the next step of searching the docs). But also broken URLs are just part of writing docs for changing software.

[VeckoTheGecko]

Having the items on stuck particles in the "Set interpolation methods" section might be unintuitive to new users.

Perhaps we can rename the group name to "Interpolation methods"? (not sure if that's the perfect solution, but I think its a bit better)

[erikvansebille]

Hmm, I prefer to keep the title to "Set interpolation methods", as most other sections also start with an active verb. Plus, stuck particles really is an issue that the interpolator can fix

[erikvansebille]

I have also reached out to the Scientific Python community about how they handle moving pages arounds (perhaps we can have automatic redirects to prevent broken URLs from doing #2966 )

OK, let me know what comes out. If we find a solution in the coming days, then it would be good to hold off with merging this PR and implement automatic redirects. Otherwise, we'll just have to accept broken links/404s...

[VeckoTheGecko]

I've added redirects in d0d2807 , they're working well. What do you think of #3039 (comment) @erikvansebille ? If you think that should also be addressed, I think it would be worth doing in this PR so we don't have to redirect multiple times.

Perhaps {group_name} instead of tutorial/explanation would be a nicer naming convention.

i.e., in group_fieldsets.md

```{toctree}
:titlesonly:
explanation_grids.ipynb
tutorial_sigma_coordinates.ipynb
tutorial_velocityconversion.ipynb
tutorial_nestedgrids.ipynb
tutorial_manipulating_field_data.ipynb
```

becomes

```{toctree}
:titlesonly:
fieldsets_grids.ipynb
fieldsets_sigma_coordinates.ipynb
fieldsets_velocityconversion.ipynb
fieldsets_nestedgrids.ipynb
fieldsets_manipulating_field_data.ipynb
```

I'll leave the decision up to you.

[VeckoTheGecko]

(ci failures unrelated)

[VeckoTheGecko]

I've merged main into here and put a link to the new tutorial_xgcm_derived_fields.ipynb in group_fieldsets.md

[erikvansebille]

Perhaps {group_name} instead of tutorial/explanation would be a nicer naming convention.

Yes, I like this proposal a lot! I'll make the change in a next commit

[VeckoTheGecko]

Gotcha, once you do that I can update all the redirects

[erikvansebille]

Gotcha, once you do that I can update all the redirects

I've now updates all the names - and also the redirects (I think). Can you check and review?

[VeckoTheGecko]

Redirects look good. Good to go!