Skip to content

DOC: better links in readme for newcomers #16639

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 2 commits into from
Jul 22, 2022
Merged

DOC: better links in readme for newcomers #16639

merged 2 commits into from
Jul 22, 2022

Conversation

tupui
Copy link
Member

@tupui tupui commented Jul 18, 2022

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:

  • At the end of the quick start guide, we should link to the dev workflow
  • The dev workflow should be updated to use 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.).
  • The dev workflow is somehow similar to the quick start document and they could almost be merged.

I can work on these in a PR if wanted.

@melissawm what do you think?

@tupui tupui added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org DX Everything related to making the experience of working on SciPy more pleasant labels Jul 18, 2022
@tupui tupui added this to the 1.10.0 milestone Jul 18, 2022
@tupui tupui requested a review from melissawm July 21, 2022 05:11
Copy link
Contributor

@mdhaber mdhaber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I'll let @melissawm take a look (and maybe merge)?

Copy link
Member

@melissawm melissawm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, just left a small suggestion to include a link to the devdocs here. Thanks @tupui

@tupui
Copy link
Member Author

tupui commented Jul 22, 2022

Thank you both for your review. I will merge this then.

@tupui tupui merged commit 1646191 into main Jul 22, 2022
@tupui tupui deleted the doc_links_readme branch July 22, 2022 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org DX Everything related to making the experience of working on SciPy more pleasant
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants