Skip to content

Expand section "Contributing to Documentation" #8042

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

Closed
humitos opened this issue Mar 23, 2021 · 0 comments · Fixed by #8082
Closed

Expand section "Contributing to Documentation" #8042

humitos opened this issue Mar 23, 2021 · 0 comments · Fixed by #8082
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@humitos
Copy link
Member

humitos commented Mar 23, 2021

We have this section https://docs.readthedocs.io/en/stable/contribute.html#contributing-to-documentation that doesn't have too much content and links to https://docs.readthedocs.io/en/stable/development/docs.html

However, the content of the second page is not great. We should explain how to make some documentation changes just by using the PR builder: editing a file using GitHub UI and previewing the changes at Read the Docs.

Besides, we could create a section that explains how to do it locally with Sphinx if the changes are going to be bigger: re-structure of documentation, whole new page, etc

Ref: #7994 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant