@@ -125,19 +125,19 @@ by building, versioning, and hosting of your docs, automatically.
125
125
Treating documentation like code keeps your team in the same tools,
126
126
and your documentation up to date.
127
127
128
- | :arrows_counterclockwise: | Up to date documentation
128
+ Up to date documentation
129
129
Whenever you push code to Git,
130
130
Read the Docs will automatically build your docs
131
131
so your code and documentation are always up-to-date.
132
132
Get started with our :doc: `tutorial </tutorial/index >`.
133
133
134
- | :card_index_dividers: | Documentation for every version
134
+ Documentation for every version
135
135
Read the Docs can host multiple versions of your docs.
136
136
Keep your 1.0 and 2.0 documentation online,
137
137
pulled directly from Git.
138
138
Start hosting all your :doc: `versions </versions >`.
139
139
140
- | :heartbeat: | Open source and user focused
140
+ Open source and user focused
141
141
Our company is bootstrapped and 100% user-focused,
142
142
so our product gets better for our users instead of our investors.
143
143
|org_brand | hosts documentation for over 100,000 large
@@ -152,89 +152,112 @@ We have a few places for you to get started:
152
152
153
153
.. descriptions here are active
154
154
155
- π :doc: `/tutorial/index `
155
+ :doc: `/tutorial/index `
156
156
Take the first practical steps with Read the Docs.
157
157
158
- π :doc: `/examples `
158
+ :doc: `/choosing-a-site `
159
+ Learn about the differences between |org_brand | and |com_brand |.
160
+
161
+ :doc: `/examples `
159
162
Start your journey with an example project to hit the ground running.
160
163
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
+ -------------------------------
164
166
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:
172
168
169
+ :doc: `/config-file/index `
170
+ Learn how to configure your project with a ``.readthedocs.yaml `` file.
173
171
174
- Explanation
175
- -----------
172
+ :doc: ` /guides/reproducible-builds `
173
+ Learn how to make your builds reproducible.
176
174
177
- Get a high-level overview of our platform:
175
+ Build process
176
+ -------------
178
177
179
- .. Descriptions here are focused on learning
178
+ Build your documentation with ease:
180
179
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.
183
182
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 .
186
185
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:
189
190
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.
192
193
193
- π‘ :doc: `All explanation articles < /explanation/index > `
194
- Browse all our explanation articles .
194
+ :doc: `/subprojects `
195
+ Host multiple projects under a single domain .
195
196
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.
196
233
197
234
How-to guides
198
235
-------------
199
236
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:
206
238
207
- πͺ :doc: `/guides/pull-requests `
239
+ :doc: `/guides/pull-requests `
208
240
Setup pull request builds and enjoy previews of each commit.
209
241
210
- πͺ :doc: `/analytics `
242
+ :doc: `/analytics `
211
243
Learn more about how users are interacting with your documentation.
212
244
213
- πͺ :doc: `/guides/cross-referencing-with-sphinx `
245
+ :doc: `/guides/cross-referencing-with-sphinx `
214
246
Learn how to use cross-references in a Sphinx project.
215
247
216
- πͺ :doc: `All how-to guides </guides/index >`
248
+ :doc: `All how-to guides </guides/index >`
217
249
Browser the entire catalog for many more how-to guides.
218
250
219
251
Reference
220
252
---------
221
253
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:
224
255
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.
235
258
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 .
238
261
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