Skip to content

Point new contributors to other pieces in the RTD ecosystem #5676

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
agjohnson opened this issue May 7, 2019 · 2 comments
Closed

Point new contributors to other pieces in the RTD ecosystem #5676

agjohnson opened this issue May 7, 2019 · 2 comments
Labels
Accepted Accepted issue on our roadmap Needed: documentation Documentation is required

Comments

@agjohnson
Copy link
Contributor

agjohnson commented May 7, 2019

The core team has decided that the code for Read the Docs is not the best place to send new contributors. We've found it's really hard to point contributors to digestible work, and setup is already complex, and scheduled to become more complex. There are a number of areas where contributors can get started with less trouble:

  • Sphinx extensions
  • Our theme
  • Eventually we want to have digestible extensions and integrations, which are maybe external from our central code

We should update our contributing materials to reflect this decision

@agjohnson agjohnson added Needed: documentation Documentation is required Accepted Accepted issue on our roadmap labels May 7, 2019
@humitos humitos added this to the Better user documentation milestone May 8, 2019
@benjaoming benjaoming self-assigned this Jun 15, 2022
ericholscher pushed a commit that referenced this issue May 19, 2025
Addresses #5676 

<!-- readthedocs-preview docs start -->
---
:books: Documentation previews :books:

- User's documentation (`docs`):
https://docs--12191.org.readthedocs.build/12191/

<!-- readthedocs-preview docs end -->

<!-- readthedocs-preview dev start -->
- Developer's documentation (`dev`):
https://dev--12191.org.readthedocs.build/12191/

<!-- readthedocs-preview dev end -->

---------

Signed-off-by: Pavithra Eswaramoorthy <[email protected]>
@ericholscher
Copy link
Member

Small version of this is done! Not sure if we need more here -- I think we can probably close it.

@humitos
Copy link
Member

humitos commented May 20, 2025

I'm fine closing this issue. We can point people to addons eventually as well since those are more self-contained and may not require the whole Read the Docs development environment to work on them.

However, we are in a transition now to redesign the UI so may not be a good moment to point people there right now.

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

No branches or pull requests

4 participants