-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Docs: New Explanation sub-levels + high-level introduction as explanation (Diátaxis) #10071
Closed
benjaoming
wants to merge
49
commits into
readthedocs:main
from
benjaoming:diataxis/explanation-refactor
Closed
Changes from 34 commits
Commits
Show all changes
49 commits
Select commit
Hold shift + click to select a range
f784be2
Write a very bad introduction to structuring docs
ericholscher 74300b6
Refactor Explanation navigation for new sub-levels
benjaoming 743095b
Merge branch 'diataxis-guide' of github.com:readthedocs/readthedocs.o…
benjaoming 2016b79
Add new topics
benjaoming 4119923
Add suggestions from previous PR
benjaoming ee2be1a
Rename to "Continuous Documentation", it fits in one line and is a mo…
benjaoming d51c79a
First quick take at introducing a dedicated documentation platform, s…
benjaoming 8add1b5
WIP: marking an idea of a short and long version of process (needs po…
benjaoming 051a425
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 33533fb
Add a better outline of what the article should contain
benjaoming ef49cc6
Merge branch 'diataxis/explanation-refactor' of github.com:benjaoming…
benjaoming 17d5ba8
Add a bit more copy
benjaoming f08d6cf
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 99fd304
WIP: Removes a lot of intentions and finishes first-draft of remainin…
benjaoming 5b4faf4
Lots of changes, including removal of /choosing-a-site and /integrations
benjaoming 8626053
We should also say "Read the Docs"
benjaoming 4b4c2a7
Improve the examples in Features for the lifecycle of a documentation…
benjaoming ef44e25
Remove a dangling sentence
benjaoming f83abb8
Add term reference
benjaoming 2c45f4c
Some texts dangling in Continuous Documentation
benjaoming 0605a44
Big TODO here
benjaoming 8b42967
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 5d3d4c5
Add quick intros to "Deep Dive into Read the Docs"
benjaoming 7e462bb
Merge branch 'diataxis/explanation-refactor' of github.com:benjaoming…
benjaoming 6b597ad
Split out methodology section to separate PR
benjaoming bf1eb49
Remove intro sentence that probably begs for a reference to a mission…
benjaoming e7982bb
Improve language, added new section "batteries included", diagram abo…
benjaoming 705623d
Add note about "Reader features" rename, update SVG
benjaoming d1be69b
Additional seealso:: for feature reference (TODO: include:: it)
benjaoming 2964fff
Apply suggestions from @humitos code review
benjaoming 19c6422
A couple of quick updates from @humitos' review
benjaoming 53edc83
Delete commented out feature list
benjaoming 109abd3
Update definitions - define first, then examples
benjaoming 38ad40f
Add some more notes, ideas, polish introduction a bit
benjaoming f5e0c09
Try and initial restructuring...
ericholscher ae4e1ae
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 5a23748
Add CDN, mention scaling from small project to enterprise, link to ve…
benjaoming ada4d44
Lifecycle not life-cycle
benjaoming 9cda9c6
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 30be3ef
Merge branch 'diataxis/explanation-refactor' of github.com:benjaoming…
benjaoming 601b049
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 8fc9b51
Update term ref
benjaoming 233bbb7
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming afd2237
Merge branch 'diataxis/explanation-refactor' of github.com:benjaoming…
benjaoming 93c6e8e
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming f57c972
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming 3de54d8
Update orphaned explanation index
benjaoming 77cbb2c
Remove a couple of old comments
benjaoming e2f34c9
Merge branch 'main' of github.com:readthedocs/readthedocs.org into di…
benjaoming File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
Deep dive into Read the Docs | ||
============================ | ||
|
||
In this section, | ||
we explain some of the more specific or advanced concepts of writing documentation on Read the Docs. | ||
|
||
⏩️ :doc:`/subprojects` | ||
Thinking about gathering several documentation projects under the same umbrella? | ||
This is a common need, and using *subprojects* is a flexible option that is recommended for most cases. | ||
|
||
⏩️ :doc:`/localization` | ||
Learn more about multilingual documentation projects and how translation workflows are supported. | ||
|
||
⏩️ :doc:`/downloadable-documentation` | ||
An introduction to adding downloadable files that can be read offline to your documentation and keep them versioned. | ||
|
||
⏩️ :doc:`/environment-variables` | ||
Environment variables can be used to make your documentation builds flexible and easy to customize. | ||
This is a general introduction to environment variables on our platform, both pre-defined and custom environment variables. | ||
|
||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:hidden: | ||
|
||
/subprojects | ||
/localization | ||
/downloadable-documentation | ||
/environment-variables |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
This is beyond what I can remember, but at some point we started saying "pre-defined environment variables", I'm guessing that it's less ambiguous and much easier to understand when put up next to "user-defined environment variables".
This is a slightly random change since we are referencing the article from Explanation.. and there might be more similar occurrences of the above, I haven't checked.