Rearrange docs to make the content more discoverable for newcomers #12612
+180
−148
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.
Improve Documentation Structure and Navigation
This PR restructures the Dune documentation to make it more intuitive and easier to navigate, following better information architecture principles.
Changes
Documentation Reorganization:
Renamed files for clarity:
usage.rst→command-line-interface.rst- More descriptive title that clearly indicates the contentquick-start.rst→practical-examples.rst- Better reflects the actual contentCreated new
core-conceptsdirectory:explanation/mental-model.rst→core-concepts/mental-model.rstexplanation/scopes.rst→core-concepts/scopes.rstcore-concepts/terminology.rstwith comprehensive glossary of Dune terms (I have no idea why this was inoverview.rst)core-concepts/index.rstas a landing pageFlattened tutorial structure:
tutorials/developing-with-dune/*→first-steps-with-dune/*(8 files)tutorials/dune-package-management/*→dune-package-management/*(5 files)Added URL redirects to preserve backlinks:
sphinx-reredirectsdependency to handle URL redirectsconf.pyto maintain backward compatibility for all renamed/moved pagesRearranged main table of contents to have a progression of content for newcomers
Motivation
The previous documentation structure had several issues:
explanation/directory was ambiguous in purpose (covering both basic ideas that beginners would benefit from understanding, as well as ideas that are more relevant to contributors to the Dune project)tutorials/hierarchy added unnecessary nesting (which made it difficult to see the most important tutorials right away, requiring people to click intotutorialsto get started)Follow-Up Tasks