Skip to content

Docs: Navigation reorder (Diátaxis) #10026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 15, 2023
Merged

Docs: Navigation reorder (Diátaxis) #10026

Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
69a3403
Put the toctrees at the top of index.rst content
benjaoming Feb 14, 2023
0b03097
Re-order explanation
benjaoming Feb 14, 2023
3d35525
Move how-to guides before explanation
benjaoming Feb 14, 2023
e2fac21
Emojis in navigation
benjaoming Feb 14, 2023
d3f67e3
re-order reference items
benjaoming Feb 14, 2023
2191ddb
Lots of TOC refactoring
ericholscher Feb 14, 2023
6e40547
A bit more futzing
ericholscher Feb 15, 2023
877f2e0
Remove underscores from files, and do a bit more cleanup
ericholscher Feb 15, 2023
e041d25
Fix links
ericholscher Feb 15, 2023
80c9f2e
Single TOC for all
ericholscher Feb 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 57 additions & 63 deletions docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,63 @@
Read the Docs: Documentation Simplified
=======================================

.. toctree::
:maxdepth: 2
:hidden:
:caption: Tutorials 🚀

/tutorial/index
/intro/getting-started-with-sphinx
/intro/getting-started-with-mkdocs
/intro/import-guide

.. toctree::
:maxdepth: 2
:hidden:
:caption: How-to guides 🪄

/guides/authors
/guides/administrators
/guides/developers
Troubleshooting </guides/troubleshooting/index>
/examples
/faq

.. toctree::
:maxdepth: 2
:hidden:
:caption: Explanation 💡

/choosing-a-site
/integrations
/pull-requests
/science
/automatic-redirects
/guides/technical-docs-seo-guide
/localization
/build-notifications
/custom-domains
/connected-accounts
/downloadable-documentation
/subprojects
/single_version
/environment-variables

.. toctree::
:maxdepth: 2
:hidden:
:caption: Reference 📚

/reference/features
/about/index
/api/index
/server-side-search/api
/server-side-search/syntax
/reference/environment-variables
changelog
/glossary
Developer Documentation 🔗 <https://dev.readthedocs.io>

.. meta::
:description lang=en: Automate building, versioning, and hosting of your technical documentation continuously on Read the Docs.

Expand Down Expand Up @@ -57,69 +114,6 @@ to help you create fantastic documentation for your project.
* **Importing your existing documentation**:
:doc:`Import guide </intro/import-guide>`


.. toctree::
:maxdepth: 2
:hidden:
:caption: Tutorials

/tutorial/index
/intro/getting-started-with-sphinx
/intro/getting-started-with-mkdocs
/intro/import-guide


.. toctree::
:maxdepth: 2
:hidden:
:glob:
:caption: Explanation

/localization
/choosing-a-site
/build-notifications
/integrations
/custom-domains
/environment-variables
/pull-requests
/connected-accounts
/downloadable-documentation
/subprojects
/single_version
/science
/automatic-redirects
/guides/technical-docs-seo-guide

.. toctree::
:maxdepth: 2
:hidden:
:caption: How-to Guides

/guides/authors
/guides/administrators
/guides/developers
Troubleshooting </guides/troubleshooting/index>
/examples
/faq


.. toctree::
:maxdepth: 2
:hidden:
:caption: Reference
:glob:

/reference/features
/api/index
/server-side-search/api
/server-side-search/syntax
/reference/environment-variables
changelog
Developer Documentation 🔗 <https://dev.readthedocs.io>
/about/index
/glossary


Read the Docs feature overview
------------------------------

Expand Down