Skip to content
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

Update contributing docs for RTD's own docs #5522

Merged
merged 1 commit into from Mar 22, 2019

Conversation

@davidjb
Copy link
Contributor

@davidjb davidjb commented Mar 22, 2019

This makes a few improvements to the documentation for Read the Docs itself:

  • Better explains how to perform a local install for working on the docs
  • Explains there's a separate page for guidelines for docs on the contributing page
  • Updates the URL in GitHub's contributing doc to use https + new readthedocs.io domain
* Better explains how to local install for working on the docs
* Explains there's contributing guidelines for docs on the contributing page
* Updates the URL in GitHub's contributing doc to https + new URL
stsewd
stsewd approved these changes Mar 22, 2019
Copy link
Member

@stsewd stsewd left a comment

Thanks for improving our documentation! We really appreciate it ❤️

@stsewd stsewd requested a review from Mar 22, 2019
@davidjb
Copy link
Contributor Author

@davidjb davidjb commented Mar 22, 2019

All good, the docs install instructions are a little janky (eg stop half way through the install process and come back) so perhaps that could be improved with substitutions or the like, but this seems the lightest touch for now!

Copy link
Member

@ericholscher ericholscher left a comment

Looks good, thanks for the updates!

@ericholscher ericholscher merged commit 7f01677 into readthedocs:master Mar 22, 2019
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants