Skip to content

Improve documentation on contributing to documentation #8082

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 19 commits into from
Apr 15, 2021
Merged
Changes from 5 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
29 changes: 26 additions & 3 deletions docs/development/docs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,27 +10,50 @@ The docs are kept in the ``docs/`` directory at the top of the source tree.
However, if there is going to be periodic/bigger contributions, it may be a
good idea to install the Sphinx requirements to build our docs.

Contributing through the Github UI
----------------------------------

If you're making small changes to the documentation, you can verify those changes through the documentation generated when you open a PR and can be accessed using the Github UI.

1. click the checkmark next to your commit and it will expand to have multiple options
2. right-click the "details" link next to the "docs/readthedocs.org:docs" item
3. navigate to the section of the documentation you worked on to verify your changes

Contributing from your local machine
------------------------------------

If you're making large changes to the documentation, you'll want to verify those changes locally before pushing upstream.

1. follow the instructions to `Set up your environment <https://docs.readthedocs.io/en/stable/development/install.html#set-up-your-environment>`__
2. go back to <http://community.dev.readthedocs.io/>`__ and login as `admin/admin`
3. find the "Read the Docs" Project, click through, and build the `latest` version
4. once the build completes, click the "View Docs" button in the top right to view your development docs
5. rebuild the "Read the Docs" Project each time you'd like to see your latest changes

Guidelines
----------

Please follow these guidelines when updating our docs.
Let us know if you have any questions or something isn't clear.

The brand
---------
^^^^^^^^^

We are called **Read the Docs**.
The *the* is not capitalized.

We do however use the acronym **RTD**.

Titles
------
^^^^^^

For page titles, or Heading1 as they are sometimes called, we use title-case.

If the page includes multiple sub-headings (H2, H3),
we usually use sentence-case unless the titles include terminology that is supposed to be capitalized.

Content
-------
^^^^^^^

* Do not break the content across multiple lines at 80 characters,
but rather break them on semantic meaning (e.g. periods or commas).
Expand Down