Skip to content

Docs: Relabel "Single version documentation" documentation from feature to explanation (Diátaxis) #9835

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.

Sign up for GitHub

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 4 commits into from
Dec 22, 2022
Merged

Docs: Relabel "Single version documentation" documentation from feature to explanation (Diátaxis) #9835

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
79007c2
WIP: Updates to "Single version documentation" documentation
benjaoming Dec 21, 2022
c8e4e54
Apply suggestions from code review
benjaoming Dec 22, 2022
b2d589c
Fix whitespace
benjaoming Dec 22, 2022
5537b03
Merge branch 'diataxis/main' into diataxis/relabel-single-version
benjaoming Dec 22, 2022
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
2 changes: 1 addition & 1 deletion docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ to help you create fantastic documentation for your project.
/custom-domains
/pull-requests
/downloadable-documentation
/single_version

.. toctree::
:maxdepth: 2
Expand Down Expand Up @@ -232,7 +233,6 @@ out of your documentation and Read the Docs.
:caption: Advanced features

subprojects
single_version
flyout-menu
feature-flags

Expand Down
14 changes: 10 additions & 4 deletions docs/user/single_version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,24 @@
Single Version Documentation
Single version documentation
----------------------------

Single Version Documentation lets you serve your docs at a root domain.
*Single version* documentation lets you serve your documentation direct from ``https://docs.example.com`` or ``https://example.readthedocs.io``.

By default, all documentation served by Read the Docs has a root of ``/<language>/<version>/``.
But, if you enable the "Single Version" option for a project, its documentation will instead be served at ``/``.
But, if you enable the *single version* option for a project, its documentation will instead be served at ``/``.

.. warning:: This means you can't have translations or multiple versions for your documentation.

Having a single version of a documentation project can be considered the better choice
in cases where there should only always exist one unambiguous copy of your project.

For example, a research project may wish to *only* expose readers to their latest list of publications and research data.

You can see a live example of this at http://www.contribution-guide.org

Enabling
~~~~~~~~

You can toggle the "Single Version" option on or off for your project in the Project Admin page.
In your project's :guilabel:`Admin` page, you can toggle the :guilabel:`Single version` option on or off for your project .
Check your :term:`dashboard` for a list of your projects.

Effects
Expand Down