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

Document installation and public PyPy #8

Open
andreap-bh opened this issue May 31, 2023 · 2 comments
Open

Document installation and public PyPy #8

andreap-bh opened this issue May 31, 2023 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@andreap-bh
Copy link

andreap-bh commented May 31, 2023

Describe the bug

  1. no link to the readthedocs documentation, neither in the About section of the project nor in the README.MD
  2. Improve installation guide by:

To Reproduce
N/A

Expected behavior
User easily consults documentation on readthedocs, and installs package with pip

Screenshots
No link to documentation in the About section:
image

Additional context
N/A

@valvgab-bh
Copy link
Collaborator

Thanks @andreap-bh. As for the link to the documentation in the README.md, there is an actionable button right below the library name, but I agree it should be made more visible (e.g. in the About section, as you suggest).

image

I fully agree on the rest. We will try to fix asap. Or you could open a pull request to solve the issue yourself, if you like :)

@valvgab-bh
Copy link
Collaborator

@Somasundaram-Palaniappan do you think we could make this wheel name get updated automatically, after publishing a new release?

image

We should also remove the section "installing inside BH", as Andrea suggests.

@valvgab-bh valvgab-bh added the documentation Improvements or additions to documentation label Jun 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants