Skip to content

Add link to user documentation at https://docs.pypi.org/ in footer or other prominent location #17959

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

Open
stevepiercy opened this issue Apr 14, 2025 · 1 comment · May be fixed by #17999
Open
Assignees
Labels
documentation feature request HTML requires change to HTML files

Comments

@stevepiercy
Copy link

What's the problem this feature will solve?

I could not find a link to the Warehouse or PyPI user documentation anywhere. There is an FAQ, but it did not answer my question, specifically how to get unverified details to be verified for my package.

Describe the solution you'd like

Add a link to the user documentation at https://docs.pypi.org/ in the footer or other prominent location.

Additional context

I eventually found the user documentation as follows.

  1. Scrolled to the footer to look for the right link under Help.
  2. User guide: wrong link.
  3. FAQ: nope again.
  4. Contribute on GitHub: Aha! Now we're getting somewhere!
  5. Searched for the term Unverified details. Bingo!
  6. Navigated to https://github.com/pypi/warehouse/blob/main/docs/user/project_metadata.md?plain=1
  7. Read the relevant docs. Much rejoicing!
  8. Saw a README.md in the same directory, and read it to finally find the URL to the PyPI User Documentation as https://docs.pypi.org/
  9. Viewed and searched the HTML source of PyPI for https://docs.pypi.org/ to ensure it wasn't hidden somewhere that I missed. Came up empty.

Thank you for your consideration.

@stevepiercy stevepiercy added feature request requires triaging maintainers need to do initial inspection of issue labels Apr 14, 2025
@woodruffw
Copy link
Member

Thanks for the request @stevepiercy! I agree the user docs should be linked more prominently -- at the moment there are a couple of links on the /help/ page, but these are not easily discoverable.

I'll look into where better we can link this.

@woodruffw woodruffw added documentation HTML requires change to HTML files and removed requires triaging maintainers need to do initial inspection of issue labels Apr 16, 2025
@woodruffw woodruffw self-assigned this Apr 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature request HTML requires change to HTML files
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants