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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
release = version
exclude_patterns = ["_build", "shared", "_includes"]
default_role = "obj"
intersphinx_cache_limit = 14 # cache for 2 weeks
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks :)

intersphinx_timeout = 3 # 3 seconds timeout
intersphinx_mapping = {
"python": ("https://docs.python.org/3.10/", None),
Expand Down
31 changes: 16 additions & 15 deletions docs/user/about/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,6 @@
About Read the Docs
===================

.. toctree::
:hidden:

/commercial/index
/reference/policies
/advertising/index
/story
/sponsors
/open-source-philosophy
/team
/support

Read the Docs is a C Corporation registered in Oregon.
Our bootstrapped company is owned and fully controlled by the founders,
and fully funded by our customers and advertisers.
Expand All @@ -38,9 +26,6 @@ This allows us to give back to the communities and projects that we support and
We are proud about the way we manage our company and products,
and are glad to have you on board with us in this :doc:`great documentation journey </story>`.

Additional content
-------------------------------

If you want to dive more into more specific information and our policies,
we've brought most of the most important ones below.

Expand Down Expand Up @@ -68,7 +53,23 @@ we've brought most of the most important ones below.
⏩ :doc:`/support`
Read this before asking for help: How to get support and where.

⏩ :doc:`/glossary`
A useful index of terms used in our docs
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like a wrong location for our Glossary?

Is it because you think the discoverability of the page itself isn't valuable? I tend to agree with that. So kind of 🧹 'ing into this corner seems fine until it has so many terms that it's a real resource.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need some other reference index to hide this stuff under, rather than in the top-level nav, is the real answer.


.. seealso::

`Our website <https://about.readthedocs.com>`__
Our primary website has general-purpose information about Read the Docs like pricing and feature overviews.

.. toctree::
:hidden:

/commercial/index
/reference/policies
/advertising/index
/story
/sponsors
/open-source-philosophy
/team
/support
/glossary
1 change: 1 addition & 0 deletions docs/user/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ from Read the Docs.

v3
v2
/server-side-search/api
2 changes: 1 addition & 1 deletion docs/user/build-default-versions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Default versions of dependencies

Read the Docs supports two tools to build your documentation:
`Sphinx <https://www.sphinx-doc.org/>`__ and `MkDocs <https://www.mkdocs.org/>`__.
In order to provide :doc:`several features </features>`,
In order to provide :doc:`several features </reference/features>`,
Read the Docs injects or modifies some content while building your docs.

In particular, if you don't specify the dependencies of your project,
Expand Down
4 changes: 2 additions & 2 deletions docs/user/commercial/sharing.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Sharing
=======
Private Documentation Sharing
=============================
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💯


.. include:: /shared/admonition-rtd-business.rst

Expand Down
4 changes: 2 additions & 2 deletions docs/user/connected-accounts.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Connecting your Git repository
==============================
How to connect your Git repository
==================================
Comment on lines +1 to +2
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was intended as an explanation since there isn't anything actionable. I can guess at several reasons that a user should read the article, and since some of them are also how-to oriented, I don't see anything bad with the refactor.

We can call it a how-to, that can work as well 👍


In this article, we explain how connecting your Read the Docs account to one of the supported Git providers
automatically configures your Git repository and your Read the Docs project.
Expand Down
91 changes: 0 additions & 91 deletions docs/user/features.rst

This file was deleted.

1 change: 1 addition & 0 deletions docs/user/guides/administrators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ have a look at our :doc:`/tutorial/index`.
:maxdepth: 1

Connect your git repository <git-integrations>
/connected-accounts
Connect your Read the Docs account to your Git repository <connecting-git-account>
Manage Custom Domains <custom-domains>
Enable Canonical URLs <canonical-urls>
Expand Down
3 changes: 3 additions & 0 deletions docs/user/guides/authors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ and :doc:`/intro/getting-started-with-mkdocs`.
cross-referencing-with-sphinx
Link to external projects (Intersphinx) <intersphinx>
jupyter
/guides/technical-docs-seo-guide
Migrate from rST to MyST <migrate-rest-myst>
enable-offline-formats
Using search analytics <search-analytics>
/automatic-redirects
/science
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hahaha, this page will keep moving around because it's such a hack.

BUT it's noted for later 👍

Copy link
Member

@ericholscher ericholscher Feb 15, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, I mostly just hid it away since it doesn't need to be in the top nav. I think it could live under a top-level Tutorials page like Specific use cases or something?

2 changes: 1 addition & 1 deletion docs/user/guides/build-troubleshooting.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Troubleshooting build errors
============================

.. include:: /shared/contribute_to_troubleshooting.rst
.. include:: /shared/contribute-to-troubleshooting.rst


Git errors
Expand Down
2 changes: 1 addition & 1 deletion docs/user/guides/build-using-too-many-resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ this troubleshooting guide will help you resolve some of the most common issues
Build resources on Read the Docs are limited to make sure that users don't overwhelm our build systems.
The current build limits can be found on our :ref:`Build resources reference <builds:Build resources>`.

.. include:: /shared/contribute_to_troubleshooting.rst
.. include:: /shared/contribute-to-troubleshooting.rst

Reduce formats you're building
------------------------------
Expand Down
1 change: 0 additions & 1 deletion docs/user/guides/developers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ or customize the documentation appearance.
embedding-content
conda
remove-edit-buttons
build-using-too-many-resources
edit-source-links-sphinx
Setup Build Notifications <build-notifications>
Use traffic analytics </analytics>
4 changes: 2 additions & 2 deletions docs/user/guides/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:orphan:
:orphan:

Guides
======
Expand All @@ -7,10 +7,10 @@ These guides will help walk you through specific use cases
related to Read the Docs itself, documentation tools like Sphinx and MkDocs
and how to write successful documentation.


.. toctree::
:maxdepth: 2

authors
administrators
build-troubleshooting
developers
8 changes: 4 additions & 4 deletions docs/user/guides/troubleshooting/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Troubleshooting guides
----------------------
Guides for troubleshooting problems
-----------------------------------

In the following guides,
you can learn how to fix common problems using Read the Docs.
Expand All @@ -10,5 +10,5 @@ you can learn how to fix common problems using Read the Docs.
.. toctree::
:maxdepth: 1

Build errors <../build-troubleshooting>
Slow builds <../build-using-too-many-resources>
../build-troubleshooting
../build-using-too-many-resources
Loading