Skip to content

Commit defcc02

Browse files
authored
Docs: 4 diátaxis categories at the top of the navigation sidebar (Diátaxis iteration 0) (#9758)
Place the 4 diátaxis categories at the top of the navigation sidebar
1 parent c2849d3 commit defcc02

File tree

1 file changed

+32
-13
lines changed

1 file changed

+32
-13
lines changed

docs/user/index.rst

+32-13
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ to help you create fantastic documentation for your project.
5656
.. toctree::
5757
:maxdepth: 2
5858
:hidden:
59-
:caption: First steps
59+
:caption: Tutorials
6060

6161
/tutorial/index
6262
/intro/getting-started-with-sphinx
@@ -65,6 +65,37 @@ to help you create fantastic documentation for your project.
6565
/choosing-a-site
6666

6767

68+
.. toctree::
69+
:maxdepth: 2
70+
:hidden:
71+
:glob:
72+
:caption: Explanation
73+
74+
/build-notifications
75+
76+
77+
.. toctree::
78+
:maxdepth: 2
79+
:hidden:
80+
:caption: How-to Guides
81+
:glob:
82+
83+
/guides/authors
84+
/guides/administrators
85+
/guides/developers
86+
/science
87+
/examples
88+
89+
90+
.. toctree::
91+
:maxdepth: 2
92+
:hidden:
93+
:caption: Reference
94+
:glob:
95+
96+
api/index
97+
98+
6899
Read the Docs feature overview
69100
------------------------------
70101

@@ -114,7 +145,6 @@ and some of the core features of Read the Docs.
114145
/server-side-search
115146
/analytics
116147
/pull-requests
117-
/build-notifications
118148
/security-log
119149

120150
/connected-accounts
@@ -159,16 +189,6 @@ and how to write successful documentation.
159189
Setup Build Notifications <build-notifications> |
160190
:doc:`More guides for developers and designers </guides/developers>`
161191

162-
.. toctree::
163-
:maxdepth: 2
164-
:hidden:
165-
:caption: How-to Guides
166-
167-
/guides/authors
168-
/guides/administrators
169-
/guides/developers
170-
/science
171-
/examples
172192

173193
Advanced features of Read the Docs
174194
----------------------------------
@@ -218,7 +238,6 @@ out of your documentation and Read the Docs.
218238
canonical-urls
219239

220240

221-
api/index
222241

223242
Read the Docs for Business
224243
--------------------------

0 commit comments

Comments
 (0)