DOC: better links in readme for newcomers #16639
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
During the sprint, we noticed that almost every newcomers were looking into
HACKING.rst.txt
. This is confusing and we should have a single place for users to look at: our dev doc.I propose to also move
HACKING.rst.txt
from the tree root into our doc. (not done yet here).Something else for the newcomers first path:
dev.py
. This page is not very visible in the TOC (we can use bold or have it as text instead of in the list, add a link to it in the text at the top of the page, etc.).I can work on these in a PR if wanted.
@melissawm what do you think?