Skip to content

Commit 7881096

Browse files
authored
Refactor the index page to match the sidebar (#11141)
This is basically just pulling the main bits from the sidebar, and putting them in the front page.
1 parent 2ac31e1 commit 7881096

File tree

1 file changed

+78
-55
lines changed

1 file changed

+78
-55
lines changed

β€Ždocs/user/index.rst

Lines changed: 78 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -125,19 +125,19 @@ by building, versioning, and hosting of your docs, automatically.
125125
Treating documentation like code keeps your team in the same tools,
126126
and your documentation up to date.
127127

128-
|:arrows_counterclockwise:| Up to date documentation
128+
Up to date documentation
129129
Whenever you push code to Git,
130130
Read the Docs will automatically build your docs
131131
so your code and documentation are always up-to-date.
132132
Get started with our :doc:`tutorial </tutorial/index>`.
133133

134-
|:card_index_dividers:| Documentation for every version
134+
Documentation for every version
135135
Read the Docs can host multiple versions of your docs.
136136
Keep your 1.0 and 2.0 documentation online,
137137
pulled directly from Git.
138138
Start hosting all your :doc:`versions </versions>`.
139139

140-
|:heartbeat:| Open source and user focused
140+
Open source and user focused
141141
Our company is bootstrapped and 100% user-focused,
142142
so our product gets better for our users instead of our investors.
143143
|org_brand| hosts documentation for over 100,000 large
@@ -152,89 +152,112 @@ We have a few places for you to get started:
152152

153153
.. descriptions here are active
154154
155-
πŸš€ :doc:`/tutorial/index`
155+
:doc:`/tutorial/index`
156156
Take the first practical steps with Read the Docs.
157157

158-
πŸš€ :doc:`/examples`
158+
:doc:`/choosing-a-site`
159+
Learn about the differences between |org_brand| and |com_brand|.
160+
161+
:doc:`/examples`
159162
Start your journey with an example project to hit the ground running.
160163

161-
πŸš€ :doc:`All tutorials </tutorials/index>`
162-
Using documentation tools like Sphinx or MkDocs for the first time or importing an existing project?
163-
We have the tutorials to get you started!
164+
Project setup and configuration
165+
-------------------------------
164166

165-
.. TODO: This above item needs its article to be finished in a separate PR
166-
.. because of what seems to be a bug in Sphinx, we get two <dl> items
167-
.. if we put comments between items.
168-
.. https://github.com/readthedocs/readthedocs.org/pull/10071
169-
.. This page isn't ready for front page treatment
170-
.. doc:`Why use a dedicated documentation platform? </integrations>`
171-
.. An introduction to some of the most important reasons for using a *Documentation CI* and build *docs as code*.
167+
Start with the basics of setting up your project:
172168

169+
:doc:`/config-file/index`
170+
Learn how to configure your project with a ``.readthedocs.yaml`` file.
173171

174-
Explanation
175-
-----------
172+
:doc:`/guides/reproducible-builds`
173+
Learn how to make your builds reproducible.
176174

177-
Get a high-level overview of our platform:
175+
Build process
176+
-------------
178177

179-
.. Descriptions here are focused on learning
178+
Build your documentation with ease:
180179

181-
.. TODO: This next item needs its article to be finished in a separate PR
182-
.. https://github.com/readthedocs/readthedocs.org/pull/10071
180+
:doc:`/builds`
181+
Overview of how documentation builds happen.
183182

184-
πŸ’‘ :doc:`Continuous Documentation </integrations>`
185-
Discover the advantages of having your documentation continuously deployed.
183+
:doc:`/pull-requests`
184+
Setup pull request builds and enjoy previews of each commit.
186185

187-
πŸ’‘ :doc:`/choosing-a-site`
188-
Learn about the differences between |org_brand| and |com_brand|.
186+
Hosting documentation
187+
---------------------
188+
189+
Learn more about our hosting features:
189190

190-
πŸ’‘ :doc:`/explanation/advanced`
191-
Get familiar with some of the more advanced topics of building and deploying documentation with Read the Docs.
191+
:doc:`/versions`
192+
Host multiple versions of your documentation.
192193

193-
πŸ’‘ :doc:`All explanation articles </explanation/index>`
194-
Browse all our explanation articles.
194+
:doc:`/subprojects`
195+
Host multiple projects under a single domain.
195196

197+
:doc:`/localization`
198+
Host your documentation in multiple languages.
199+
200+
:doc:`/versioning-schemes`
201+
Learn about different versioning schemes.
202+
203+
:doc:`/custom-domains`
204+
Host your documentation on your own domain.
205+
206+
Maintaining projects
207+
--------------------
208+
209+
Keep your documentation up to date:
210+
211+
:doc:`/user-defined-redirects`
212+
Redirect your old URLs to new ones.
213+
214+
:doc:`/reference/analytics`
215+
Learn more about how users are interacting with your documentation.
216+
217+
:doc:`/security-log`
218+
Keep track of security events in your project.
219+
220+
Business features
221+
-----------------
222+
223+
Features for organizations and businesses:
224+
225+
:doc:`/commercial/index`
226+
Learn more about our commercial features.
227+
228+
:doc:`/commercial/organizations`
229+
Learn how to manage your organization on Read the Docs.
230+
231+
:doc:`/commercial/single-sign-on`
232+
Learn how to use single sign-on with Read the Docs.
196233

197234
How-to guides
198235
-------------
199236

200-
Need to get something specific done?
201-
These guides provide step-by-step instructions in key areas to get you up to speed faster:
202-
203-
.. Descriptions here are active, learn, setup, etc.
204-
.. The chosen sample of how-tos is intended reflect to width of the how-to section
205-
.. i.e. NOT only what is most popular or easiest for beginners.
237+
Step-by-step guides for common tasks:
206238

207-
πŸͺ„ :doc:`/guides/pull-requests`
239+
:doc:`/guides/pull-requests`
208240
Setup pull request builds and enjoy previews of each commit.
209241

210-
πŸͺ„ :doc:`/analytics`
242+
:doc:`/analytics`
211243
Learn more about how users are interacting with your documentation.
212244

213-
πŸͺ„ :doc:`/guides/cross-referencing-with-sphinx`
245+
:doc:`/guides/cross-referencing-with-sphinx`
214246
Learn how to use cross-references in a Sphinx project.
215247

216-
πŸͺ„ :doc:`All how-to guides </guides/index>`
248+
:doc:`All how-to guides </guides/index>`
217249
Browser the entire catalog for many more how-to guides.
218250

219251
Reference
220252
---------
221253

222-
Need to know how something works?
223-
Here are a few of the most important reference docs:
254+
More detailed information about Read the Docs:
224255

225-
.. Descriptions here sound like reference
226-
227-
πŸ“š :doc:`/reference/features`
228-
Overview of all the main features of Read the Docs.
229-
230-
πŸ“š :doc:`/config-file/v2`
231-
Information for our configuration file: ``.readthedocs.yaml``.
232-
233-
πŸ“š :doc:`/builds`
234-
Overview of how documentation builds happen.
256+
:doc:`/api/index`
257+
Automate your documentation with our API and save yourself some work.
235258

236-
πŸ“š :doc:`/build-customization`
237-
Information on how to add your own build logic or replace default build steps.
259+
:doc:`/changelog`
260+
See what's new in Read the Docs.
238261

239-
πŸ“š :doc:`/api/index`
240-
Automate your documentation with our API and save yourself some work.
262+
:doc:`/about/index`
263+
Learn more about Read the Docs and our company.

0 commit comments

Comments
Β (0)