Skip to content

Docs: Relabel badges as feature reference (Diátaxis) #9951

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 1 commit into from
Jan 27, 2023
Merged

Docs: Relabel badges as feature reference (Diátaxis) #9951

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 26 additions & 2 deletions docs/user/badges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,18 @@ An example of each is shown here:

|green| |nbsp| |red| |nbsp| |yellow|

Automatically generated
-----------------------

On the dashboard of a project, an example badge is displayed
together with code snippets for reStructuredText, Markdown, and HTML.

Badges are generated on-demand for all Read the Docs projects, using the following URL syntax:

.. code-block:: text

https://readthedocs.org/projects/<project-slug>/badge/?version=<version>&style=<style>

Style
-----

Expand Down Expand Up @@ -56,9 +68,11 @@ You can change the version of the documentation your badge points to.
To do this, you can pass the ``version`` GET argument to the badge URL.
By default, it will point at the *default version* you have specified for your project.

The badge URL looks like this::
The badge URL looks like this:

https://readthedocs.org/projects/docs/badge/?version=latest
.. code-block:: text

https://readthedocs.org/projects/<project-slug>/badge/?version=latest


Badges on dashboard pages
Expand All @@ -75,3 +89,13 @@ to make embedding it easier.
.. |yellow| image:: https://assets.readthedocs.org/static/projects/badges/unknown-flat.svg
.. |nbsp| unicode:: 0xA0
:trim:


Badges for private projects
Copy link
Member

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

For private projects, a badge URL cannot be guessed.
A token is needed to display it.
Private badge URLs are displayed on a private project's dashboard in place of public URLs.
1 change: 0 additions & 1 deletion docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ and some of the core features of Read the Docs.
/build-customization
/build-troubleshooting
/environment-variables
/badges

/support

Expand Down
1 change: 1 addition & 0 deletions docs/user/reference/features.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Features

analytics
/server-side-search/index
/badges