Skip to content

Commit

Permalink
Refactor the index page to match the sidebar
Browse files Browse the repository at this point in the history
This is basically just pulling the main bits from the sidebar,
and putting them in the front page.
  • Loading branch information
ericholscher committed Feb 23, 2024
1 parent 3475d90 commit 817b47f
Showing 1 changed file with 78 additions and 55 deletions.
133 changes: 78 additions & 55 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -125,19 +125,19 @@ by building, versioning, and hosting of your docs, automatically.
Treating documentation like code keeps your team in the same tools,
and your documentation up to date.

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

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

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

.. descriptions here are active
πŸš€ :doc:`/tutorial/index`
:doc:`/tutorial/index`
Take the first practical steps with Read the Docs.

πŸš€ :doc:`/examples`
:doc:`/choosing-a-site`
Learn about the differences between |org_brand| and |com_brand|.

:doc:`/examples`
Start your journey with an example project to hit the ground running.

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

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

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

Explanation
-----------
:doc:`/guides/reproducible-builds`
Learn how to make your builds reproducible.

Get a high-level overview of our platform:
Build process
-------------

.. Descriptions here are focused on learning
Build your documentation with ease:

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

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

πŸ’‘ :doc:`/choosing-a-site`
Learn about the differences between |org_brand| and |com_brand|.
Hosting documentation
---------------------

Learn more about our hosting features:

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

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

:doc:`/localization`
Host your documentation in multiple languages.

:doc:`/versioning-schemes`
Learn about different versioning schemes.

:doc:`/custom-domains`
Host your documentation on your own domain.

Maintaining projects
--------------------

Keep your documentation up to date:

:doc:`/user-defined-redirects`
Redirect your old URLs to new ones.

:doc:`/reference/analytics`
Learn more about how users are interacting with your documentation.

:doc:`/security-log`
Keep track of security events in your project.

Business features
-----------------

Features for organizations and businesses:

:doc:`/commercial/index`
Learn more about our commercial features.

:doc:`/commercial/organizations`
Learn how to manage your organization on Read the Docs.

:doc:`/commercial/single-sign-on`
Learn how to use single sign-on with Read the Docs.

How-to guides
-------------

Need to get something specific done?
These guides provide step-by-step instructions in key areas to get you up to speed faster:

.. Descriptions here are active, learn, setup, etc.
.. The chosen sample of how-tos is intended reflect to width of the how-to section
.. i.e. NOT only what is most popular or easiest for beginners.
Step-by-step guides for common tasks:

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

πŸͺ„ :doc:`/analytics`
:doc:`/analytics`
Learn more about how users are interacting with your documentation.

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

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

Reference
---------

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

.. Descriptions here sound like reference
πŸ“š :doc:`/reference/features`
Overview of all the main features of Read the Docs.

πŸ“š :doc:`/config-file/v2`
Information for our configuration file: ``.readthedocs.yaml``.

πŸ“š :doc:`/builds`
Overview of how documentation builds happen.
:doc:`/api/index`
Automate your documentation with our API and save yourself some work.

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

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

0 comments on commit 817b47f

Please sign in to comment.