Meta: Document the PEP shortcut URLs?

[hugovk]

In #2420 we added shortcut redirects like https://peps.python.org/8 -> https://peps.python.org/pep-0008/

This was specifically to support GitHub's autolinking like: PEP-8 (docs).

Whilst the full zero-padded https://peps.python.org/pep-0008/ remains the canonical form, the https://peps.python.org/8 shortcuts are useful for others as well (for example), so shall we publicise or document these somewhere?

[Rosuav]

I like the idea, but I've no idea where to document them that people would actually read, given how people tend not to read documentation anyway :) Would a note in the README be sufficient?

[merwok]

On the PEP site home page?
Also devguide page about PEPs?

[CAM-Gerlach]

I like the idea, but I've no idea where to document them that people would actually read, given how people tend not to read documentation anyway :) Would a note in the README be sufficient?

Yeah, that's a good point. A note in the Readme would certainly be better than nothing, though at least if and when #10 is implemented, users aren't likely to actually see it. Then again, it's not clear how important that average users see it anyway. Typically, sites provide shortlinks using a "link"/"share" button, but there's not really a clear benefit over just copying the URL in our case, nor just using the "canonical" link there too.

On the PEP site home page?

You mean PEP 0, the PEP index? Perhaps; that would probably be best for visibility, though that seems like a fairly low-level detail to mention on a page that is very light on text and focused on being an index of the PEPs.

Also devguide page about PEPs?

Which page, sorry? The devguide currently references PEP 1 and PEP 12 as the canonical place for documenting PEP policy, process and guidance for authors. IIRC, it previously contained such a page years ago, but it had drifted way out of date with the PEP repo and actual practice and duplicated information there, so was updated to refer the reader to the canonical resources.

[hugovk]

Please see #3043 to add a note to the README.