warehouse icon indicating copy to clipboard operation
warehouse copied to clipboard

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

Open stevepiercy opened this issue 7 months ago • 1 comments

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 avatar Apr 14 '25 20:04 stevepiercy

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 avatar Apr 16 '25 20:04 woodruffw

Hi @stevepiercy - closing this as we have the docs linked to from the header, which I assume was added after you opened this ticket.

Image

If I've misunderstood, please reopen.

nlhkabu avatar Oct 28 '25 06:10 nlhkabu

Yup, it was closed by https://github.com/pypi/warehouse/pull/18164. Thank you!

stevepiercy avatar Oct 28 '25 07:10 stevepiercy