Adopt Diataxis #6868
Draft
Adopt Diataxis #6868
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
benchmark_this
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6868 +/- ##
=======================================
Coverage 90.43% 90.43%
=======================================
Files 91 91
Lines 24839 24839
Branches 4656 4656
=======================================
Hits 22463 22463
Misses 1608 1608
Partials 768 768 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
⏱️ Performance Benchmark Report: 81d3d5cPerformance shiftsFull benchmark resultsGenerated by GHA run |
trexfeathers
commented
Dec 30, 2025
Comment on lines
+4
to
+6
| The pages below do not belong to any other User Manual section. For the best | ||
| experience: we encourage you to explore the User Manual via topic or `Diataxis`_ | ||
| filters, as seen in the :doc:`../index` top page. |
Contributor
Author
There was a problem hiding this comment.
This could be a more direct/insistent instruction?
Contributor
⏱️ Performance Benchmark Report: 66292e1Performance shiftsFull benchmark resultsGenerated by GHA run |
Contributor
⏱️ Performance Benchmark Report: 1dd2193Performance shiftsFull benchmark resultsGenerated by GHA run |
1 task
![scitools-ci[bot]](https://avatars.githubusercontent.com/in/212324?s=60&v=4){kind=small}
Contributor
⏱️ Performance Benchmark Report: 80c46abPerformance shiftsFull benchmark resultsGenerated by GHA run |
Contributor
⏱️ Performance Benchmark Report: 782a5d8Performance shiftsFull benchmark resultsGenerated by GHA run |
Contributor
⏱️ Performance Benchmark Report: 39ca485Performance shiftsFull benchmark resultsGenerated by GHA run |
Contributor
⏱️ Performance Benchmark Report: 32911e1Performance shiftsFull benchmark resultsGenerated by GHA run |
trexfeathers
commented
Jan 7, 2026
Contributor
Author
trexfeathers
left a comment
trexfeathers
left a comment
There was a problem hiding this comment.
Some useful comments from @pp-mo
Comment on lines
+123
to
+124
| # Find all the topic labels in this file and construct navigation badges | ||
| # for them. |
Contributor
Author
There was a problem hiding this comment.
From @pp-mo: the size and spacing of the badges, relative to the more prominent tabs, make topics lower profile than Diataxis. Ideally we would want the profile/priority the other way around.
Comment on lines
+24
to
+44
| .. comment: | ||
| The tree structure for user_manual is specified here. As mentioned in the | ||
| text, we prefer readers to use the tabbed sections below, so the toctree is | ||
| hidden - not rendered in the text, only in the sidebar. This toctree is | ||
| expected to be section_indexes/* pages; with each of those pages | ||
| providing the remaining sub-structure. | ||
|
|
||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
| :hidden: | ||
|
|
||
| section_indexes/get_started | ||
| section_indexes/userguide | ||
| /generated/gallery/index | ||
| Iris API </generated/api/iris> | ||
| section_indexes/dask_best_practices | ||
| section_indexes/mesh_support | ||
| section_indexes/metadata_arithmetic | ||
| section_indexes/community | ||
| section_indexes/general |
Contributor
Author
There was a problem hiding this comment.
From @pp-mo: it's still pretty attention-grabbing in the left-hand bar, making it still quite easy to treat the tree structure as the main way to navigate.
The goal is to make the page list (user_manual/index.rst) the main way to navigate, with any tree structures only being relevant to individual sub-sections.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #6511
Unfortunately a fair bit left to do.
Examples- in Diataxis these should be short-and-sweet, with the remaining richness moved to dedicated How-To pagesPlanned restructure
Click to expand
further_topics/dataless_cubes.rst->explanation/dataless_cubes.rstuserguide/iris_cubes.rst->explanation/iris_cubes.rstuserguide/iris_philosophy.rst->explanation/iris_philosophy.rstsplit into sub-files?community/iris_xarray.rst->explanation/iris_xarray.rstfurther_topics/lenient_maths.rst->explanation/lenient_maths.rstfurther_topics/lenient_metadata.rst->explanation/lenient_metadata.rstfurther_topics/ugrid/data_model.rst->explanation/mesh_data_model.rstfurther_topics/ugrid/partner_packages.rst->explanation/mesh_partners.rstfurther_topics/metadata.rst->explanation/metadata.rstfurther_topics/missing_data_handling.rst->explanation/missing_data_handling.rstfurther_topics/netcdf_io.rst->explanation/netcdf_io.rstuserguide/real_and_lazy_data.rst->explanation/real_and_lazy_data.rstfurther_topics/um_files_loading.rst->explanation/um_files_loading.rstfurther_topics/which_regridder_to_use.rst->explanation/which_regridder_to_use.rstgenerated/api/iris.analysis.calculus.rst->generated/api/iris.analysis.calculus.rstlink from referencegenerated/api/iris.analysis.cartography.rst->generated/api/iris.analysis.cartography.rstlink from referencegenerated/api/iris.analysis.geometry.rst->generated/api/iris.analysis.geometry.rstlink from referencegenerated/api/iris.analysis.maths.rst->generated/api/iris.analysis.maths.rstlink from referencegenerated/api/iris.analysis.rst->generated/api/iris.analysis.rstlink from referencegenerated/api/iris.analysis.stats.rst->generated/api/iris.analysis.stats.rstlink from referencegenerated/api/iris.analysis.trajectory.rst->generated/api/iris.analysis.trajectory.rstlink from referencegenerated/api/iris.aux_factory.rst->generated/api/iris.aux_factory.rstlink from referencegenerated/api/iris.common.lenient.rst->generated/api/iris.common.lenient.rstlink from referencegenerated/api/iris.common.metadata.rst->generated/api/iris.common.metadata.rstlink from referencegenerated/api/iris.common.mixin.rst->generated/api/iris.common.mixin.rstlink from referencegenerated/api/iris.common.resolve.rst->generated/api/iris.common.resolve.rstlink from referencegenerated/api/iris.common.rst->generated/api/iris.common.rstlink from referencegenerated/api/iris.config.rst->generated/api/iris.config.rstlink from referencegenerated/api/iris.coord_categorisation.rst->generated/api/iris.coord_categorisation.rstlink from referencegenerated/api/iris.coord_systems.rst->generated/api/iris.coord_systems.rstlink from referencegenerated/api/iris.coords.rst->generated/api/iris.coords.rstlink from referencegenerated/api/iris.cube.rst->generated/api/iris.cube.rstlink from referencegenerated/api/iris.exceptions.rst->generated/api/iris.exceptions.rstlink from referencegenerated/api/iris.experimental.animate.rst->generated/api/iris.experimental.animate.rstlink from referencegenerated/api/iris.experimental.geovista.rst->generated/api/iris.experimental.geovista.rstlink from referencegenerated/api/iris.experimental.regrid.rst->generated/api/iris.experimental.regrid.rstlink from referencegenerated/api/iris.experimental.regrid_conservative.rst->generated/api/iris.experimental.regrid_conservative.rstlink from referencegenerated/api/iris.experimental.representation.rst->generated/api/iris.experimental.representation.rstlink from referencegenerated/api/iris.experimental.rst->generated/api/iris.experimental.rstlink from referencegenerated/api/iris.experimental.stratify.rst->generated/api/iris.experimental.stratify.rstlink from referencegenerated/api/iris.experimental.ugrid.rst->generated/api/iris.experimental.ugrid.rstlink from referencegenerated/api/iris.fileformats.abf.rst->generated/api/iris.fileformats.abf.rstlink from referencegenerated/api/iris.fileformats.cf.rst->generated/api/iris.fileformats.cf.rstlink from referencegenerated/api/iris.fileformats.dot.rst->generated/api/iris.fileformats.dot.rstlink from referencegenerated/api/iris.fileformats.name.rst->generated/api/iris.fileformats.name.rstlink from referencegenerated/api/iris.fileformats.name_loaders.rst->generated/api/iris.fileformats.name_loaders.rstlink from referencegenerated/api/iris.fileformats.netcdf.loader.rst->generated/api/iris.fileformats.netcdf.loader.rstlink from referencegenerated/api/iris.fileformats.netcdf.rst->generated/api/iris.fileformats.netcdf.rstlink from referencegenerated/api/iris.fileformats.netcdf.saver.rst->generated/api/iris.fileformats.netcdf.saver.rstlink from referencegenerated/api/iris.fileformats.netcdf.ugrid_load.rst->generated/api/iris.fileformats.netcdf.ugrid_load.rstlink from referencegenerated/api/iris.fileformats.nimrod.rst->generated/api/iris.fileformats.nimrod.rstlink from referencegenerated/api/iris.fileformats.nimrod_load_rules.rst->generated/api/iris.fileformats.nimrod_load_rules.rstlink from referencegenerated/api/iris.fileformats.pp.rst->generated/api/iris.fileformats.pp.rstlink from referencegenerated/api/iris.fileformats.pp_load_rules.rst->generated/api/iris.fileformats.pp_load_rules.rstlink from referencegenerated/api/iris.fileformats.pp_save_rules.rst->generated/api/iris.fileformats.pp_save_rules.rstlink from referencegenerated/api/iris.fileformats.rst->generated/api/iris.fileformats.rstlink from referencegenerated/api/iris.fileformats.rules.rst->generated/api/iris.fileformats.rules.rstlink from referencegenerated/api/iris.fileformats.um.rst->generated/api/iris.fileformats.um.rstlink from referencegenerated/api/iris.fileformats.um_cf_map.rst->generated/api/iris.fileformats.um_cf_map.rstlink from referencegenerated/api/iris.io.format_picker.rst->generated/api/iris.io.format_picker.rstlink from referencegenerated/api/iris.io.rst->generated/api/iris.io.rstlink from referencegenerated/api/iris.iterate.rst->generated/api/iris.iterate.rstlink from referencegenerated/api/iris.loading.rst->generated/api/iris.loading.rstlink from referencegenerated/api/iris.mesh.components.rst->generated/api/iris.mesh.components.rstlink from referencegenerated/api/iris.mesh.rst->generated/api/iris.mesh.rstlink from referencegenerated/api/iris.mesh.utils.rst->generated/api/iris.mesh.utils.rstlink from referencegenerated/api/iris.palette.rst->generated/api/iris.palette.rstlink from referencegenerated/api/iris.pandas.rst->generated/api/iris.pandas.rstlink from referencegenerated/api/iris.plot.rst->generated/api/iris.plot.rstlink from referencegenerated/api/iris.quickplot.rst->generated/api/iris.quickplot.rstlink from referencegenerated/api/iris.rst->generated/api/iris.rstlink from referencegenerated/api/iris.std_names.rst->generated/api/iris.std_names.rstlink from referencegenerated/api/iris.symbols.rst->generated/api/iris.symbols.rstlink from referencegenerated/api/iris.time.rst->generated/api/iris.time.rstlink from referencegenerated/api/iris.util.rst->generated/api/iris.util.rstlink from referencegenerated/api/iris.warnings.rst->generated/api/iris.warnings.rstlink from referencegenerated/gallery/general/index.rst->generated/gallery/general/index.rstlink from how_togenerated/gallery/general/plot_anomaly_log_colouring.rst->generated/gallery/general/plot_anomaly_log_colouring.rstlink from how_togenerated/gallery/general/plot_coriolis.rst->generated/gallery/general/plot_coriolis.rstlink from how_togenerated/gallery/general/plot_cross_section.rst->generated/gallery/general/plot_cross_section.rstlink from how_togenerated/gallery/general/plot_custom_aggregation.rst->generated/gallery/general/plot_custom_aggregation.rstlink from how_togenerated/gallery/general/plot_custom_file_loading.rst->generated/gallery/general/plot_custom_file_loading.rstlink from how_togenerated/gallery/general/plot_global_map.rst->generated/gallery/general/plot_global_map.rstlink from how_togenerated/gallery/general/plot_inset.rst->generated/gallery/general/plot_inset.rstlink from how_togenerated/gallery/general/plot_lineplot_with_legend.rst->generated/gallery/general/plot_lineplot_with_legend.rstlink from how_togenerated/gallery/general/plot_polar_stereo.rst->generated/gallery/general/plot_polar_stereo.rstlink from how_togenerated/gallery/general/plot_polynomial_fit.rst->generated/gallery/general/plot_polynomial_fit.rstlink from how_togenerated/gallery/general/plot_projections_and_annotations.rst->generated/gallery/general/plot_projections_and_annotations.rstlink from how_togenerated/gallery/general/plot_rotated_pole_mapping.rst->generated/gallery/general/plot_rotated_pole_mapping.rstlink from how_togenerated/gallery/general/plot_SOI_filtering.rst->generated/gallery/general/plot_SOI_filtering.rstlink from how_togenerated/gallery/general/plot_zonal_means.rst->generated/gallery/general/plot_zonal_means.rstlink from how_togenerated/gallery/general/sg_execution_times.rst->generated/gallery/general/sg_execution_times.rstlink from how_togenerated/gallery/index.rst->generated/gallery/index.rstlink from how_togenerated/gallery/meteorology/index.rst->generated/gallery/meteorology/index.rstlink from how_togenerated/gallery/meteorology/plot_COP_1d.rst->generated/gallery/meteorology/plot_COP_1d.rstlink from how_togenerated/gallery/meteorology/plot_COP_maps.rst->generated/gallery/meteorology/plot_COP_maps.rstlink from how_togenerated/gallery/meteorology/plot_deriving_phenomena.rst->generated/gallery/meteorology/plot_deriving_phenomena.rstlink from how_togenerated/gallery/meteorology/plot_hovmoller.rst->generated/gallery/meteorology/plot_hovmoller.rstlink from how_togenerated/gallery/meteorology/plot_lagged_ensemble.rst->generated/gallery/meteorology/plot_lagged_ensemble.rstlink from how_togenerated/gallery/meteorology/plot_TEC.rst->generated/gallery/meteorology/plot_TEC.rstlink from how_togenerated/gallery/meteorology/plot_wind_barbs.rst->generated/gallery/meteorology/plot_wind_barbs.rstlink from how_togenerated/gallery/meteorology/plot_wind_speed.rst->generated/gallery/meteorology/plot_wind_speed.rstlink from how_togenerated/gallery/meteorology/sg_execution_times.rst->generated/gallery/meteorology/sg_execution_times.rstlink from how_togenerated/gallery/oceanography/index.rst->generated/gallery/oceanography/index.rstlink from how_togenerated/gallery/oceanography/plot_atlantic_profiles.rst->generated/gallery/oceanography/plot_atlantic_profiles.rstlink from how_togenerated/gallery/oceanography/plot_load_nemo.rst->generated/gallery/oceanography/plot_load_nemo.rstlink from how_togenerated/gallery/oceanography/plot_orca_projection.rst->generated/gallery/oceanography/plot_orca_projection.rstlink from how_togenerated/gallery/oceanography/sg_execution_times.rst->generated/gallery/oceanography/sg_execution_times.rstlink from how_togenerated/gallery/sg_execution_times.rst->generated/gallery/sg_execution_times.rstlink from how_togetting_started.rst->user_manual/section_indexes/get_startedReference a minimum: Data Structures, Loading Iris Cubes up to end of Lazy Loadinginstalling.rst->how_to/installing.rstwhy_iris.rst->explanation/why_iris.rstfurther_topics/index.rst->GONEnew structurefurther_topics/filtering_warnings.rst->how_to/filtering_warnings.rstfurther_topics/ugrid/other_meshes.rst->how_to/mesh_conversions.rstfurther_topics/ugrid/operations.rst->how_to/mesh_operations.rstuserguide/navigating_a_cube.rst->how_to/navigating_a_cube.rstcommunity/plugins.rst->how_to/plugins.rstindex.rst->index.rstcopyright.rst->copyright.rstuserguide/glossary.rst->reference/glossary.rstcommunity/phrasebook.rst->reference/phrasebook.rstuserguide/index.rst->REPLACEneed a new statement on the minimum reading requirementsg_execution_times.rst->sg_execution_times.rstfurther_topics/controlling_merge.rst->tutorial/controlling_merge.rstuserguide/cube_maths.rst->tutorial/cube_maths.rstuserguide/cube_statistics.rst->tutorial/cube_statistics.rstfurther_topics/dask_best_practices/dask_bags_and_greed.rst->tutorial/dask_best_practices/dask_bags_and_greed.rstfurther_topics/dask_best_practices/dask_parallel_loop.rst->tutorial/dask_best_practices/dask_parallel_loop.rstfurther_topics/dask_best_practices/dask_pp_to_netcdf.rst->tutorial/dask_best_practices/dask_pp_to_netcdf.rstfurther_topics/dask_best_practices/index.rst->tutorial/dask_best_practices/index.rstuserguide/interpolation_and_regridding.rst->tutorial/interpolation_and_regridding.rstuserguide/loading_iris_cubes.rst->tutorial/loading_iris_cubes.rstuserguide/merge_and_concat.rst->tutorial/merge_and_concat.rstuserguide/plotting_a_cube.rst->tutorial/plotting_a_cube.rstuserguide/saving_iris_cubes.rst->tutorial/saving_iris_cubes.rstuserguide/subsetting_a_cube.rst->tutorial/subsetting_a_cube.rstwhatsnew/1.0.rst->whatsnew/1.0.rsttoctree = referencewhatsnew/1.1.rst->whatsnew/1.1.rsttoctree = referencewhatsnew/1.10.rst->whatsnew/1.10.rsttoctree = referencewhatsnew/1.11.rst->whatsnew/1.11.rsttoctree = referencewhatsnew/1.12.rst->whatsnew/1.12.rsttoctree = referencewhatsnew/1.13.rst->whatsnew/1.13.rsttoctree = referencewhatsnew/1.2.rst->whatsnew/1.2.rsttoctree = referencewhatsnew/1.3.rst->whatsnew/1.3.rsttoctree = referencewhatsnew/1.4.rst->whatsnew/1.4.rsttoctree = referencewhatsnew/1.5.rst->whatsnew/1.5.rsttoctree = referencewhatsnew/1.6.rst->whatsnew/1.6.rsttoctree = referencewhatsnew/1.7.rst->whatsnew/1.7.rsttoctree = referencewhatsnew/1.8.rst->whatsnew/1.8.rsttoctree = referencewhatsnew/1.9.rst->whatsnew/1.9.rsttoctree = referencewhatsnew/2.0.rst->whatsnew/2.0.rsttoctree = referencewhatsnew/2.1.rst->whatsnew/2.1.rsttoctree = referencewhatsnew/2.2.rst->whatsnew/2.2.rsttoctree = referencewhatsnew/2.3.rst->whatsnew/2.3.rsttoctree = referencewhatsnew/2.4.rst->whatsnew/2.4.rsttoctree = referencewhatsnew/3.0.rst->whatsnew/3.0.rsttoctree = referencewhatsnew/3.1.rst->whatsnew/3.1.rsttoctree = referencewhatsnew/3.10.rst->whatsnew/3.10.rsttoctree = referencewhatsnew/3.11.rst->whatsnew/3.11.rsttoctree = referencewhatsnew/3.12.rst->whatsnew/3.12.rsttoctree = referencewhatsnew/3.13.rst->whatsnew/3.13.rsttoctree = referencewhatsnew/3.14.rst->whatsnew/3.14.rsttoctree = referencewhatsnew/3.2.rst->whatsnew/3.2.rsttoctree = referencewhatsnew/3.3.rst->whatsnew/3.3.rsttoctree = referencewhatsnew/3.4.rst->whatsnew/3.4.rsttoctree = referencewhatsnew/3.5.rst->whatsnew/3.5.rsttoctree = referencewhatsnew/3.6.rst->whatsnew/3.6.rsttoctree = referencewhatsnew/3.7.rst->whatsnew/3.7.rsttoctree = referencewhatsnew/3.8.rst->whatsnew/3.8.rsttoctree = referencewhatsnew/3.9.rst->whatsnew/3.9.rsttoctree = referencewhatsnew/index.rst->whatsnew/index.rsttoctree = referencewhatsnew/latest.rst->whatsnew/latest.rsttoctree = referenceDetails