python-docs-theme icon indicating copy to clipboard operation
python-docs-theme copied to clipboard

Change root url to docs.python.org

Open StanFromIreland opened this issue 11 months ago โ€ข 4 comments

Closes #217


๐Ÿ“š Documentation preview ๐Ÿ“š: https://python-docs-theme-previews--220.org.readthedocs.build/

StanFromIreland avatar Feb 02 '25 17:02 StanFromIreland

Mobile

image

The logo always links to docs.python.org. That's okay when we're looking the 3.13 docs, but if we're looking at, say, 3.11 or 3.14, we'll end up at a different docs set which would be confusing.

Can it point to the same docs homepage we're looking at?

Desktop

With this change, these circled links both point to the docs homepage:

image

Before, the first one pointed to www.python.org, and the chevrons "ยป" indicated a hierarchy. Is it a bit odd that the upper level link is the same as the next one?

Or I guess, the top one is docs.python.org and the next is docs.python.org/3.x, so that's kind of a hierarchy, for the default case of docs.python.org >> docs.python.org/3, but maybe not really for, say, docs.python.org >> docs.python.org/3.11?

And do we want to lose the link to www.python.org?

The logo doesn't point to anything here.

hugovk avatar Feb 02 '25 21:02 hugovk

I don't see a need for a button to python.org, it is linked when necessary.

StanFromIreland avatar Feb 04 '25 17:02 StanFromIreland

We discussed this in the monthly docs workgroup meeting and decided to replace the www.python.org link with a docs.python.org one.

We can add a link under "Project information:" to www.python.org.


Not brought up in the meeting, but as mentioned in https://github.com/python/python-docs-theme/pull/220#issuecomment-2629560831, let's make sure the link doesn't go to the default docs.python.org for all docs versions; it should go to the homepage of that version.

For example, if on this page, the link should go to that page:

  • https://docs.python.org/3/library/hashlib.html -> https://docs.python.org/3/
  • https://docs.python.org/3.11/library/hashlib.html -> https://docs.python.org/3.11/
  • https://docs.python.org/dev/library/hashlib.html -> https://docs.python.org/dev/

hugovk avatar Feb 04 '25 21:02 hugovk

All commit authors signed the Contributor License Agreement.

CLA signed

python-cla-bot[bot] avatar Apr 06 '25 13:04 python-cla-bot[bot]