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

Add link to documentation (docs.astral.sh/uv) #5973

Closed
nikhilweee opened this issue Aug 9, 2024 · 4 comments
Closed

Add link to documentation (docs.astral.sh/uv) #5973

nikhilweee opened this issue Aug 9, 2024 · 4 comments
Labels
duplicate This issue or pull request already exists

Comments

@nikhilweee
Copy link

For weeks, I thought uv did not have documentation available apart from the README. Then I stumbled upon docs.astral.sh/uv

It would be great if this link could be advertised at least in two places:

  1. In the repository "About" section
  2. Relevant sections in the README.

A good comparison is ruff, which has a link to its docs in the repository "About" section and in various places in its README.

@nikhilweee
Copy link
Author

Honestly I'm fine with just doing (1), but that needs to be done by an admin.

@zanieb
Copy link
Member

zanieb commented Aug 9, 2024

You can follow #5606 and #5607

This documentation is not intended for public consumption yet, hence not being advertised anywhere. We'll announce it soon!

@zanieb zanieb closed this as not planned Won't fix, can't repro, duplicate, stale Aug 9, 2024
@zanieb zanieb added the duplicate This issue or pull request already exists label Aug 9, 2024
@zanieb
Copy link
Member

zanieb commented Aug 9, 2024

If you have feedback though, please feel free to comment at #5605 — I'd love to hear your perspective on the documentation itself.

@nikhilweee
Copy link
Author

Apologies for not searching enough, I remember searching the issues for any links to documentation a few days ago but those issues you refer to were opened last week. Eagerly waiting for the docs! Thank you for all the hard work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
duplicate This issue or pull request already exists
Projects
None yet
Development

No branches or pull requests

2 participants