-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Changes from all commits
69a3403
0b03097
3d35525
e2fac21
d3f67e3
2191ddb
6e40547
877f2e0
e041d25
80c9f2e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
|
@@ -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. | ||
|
||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,3 +12,4 @@ from Read the Docs. | |
|
||
v3 | ||
v2 | ||
/server-side-search/api |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
Sharing | ||
======= | ||
Private Documentation Sharing | ||
============================= | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 💯 |
||
|
||
.. include:: /shared/admonition-rtd-business.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
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
This file was deleted.
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 👍 There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks :)