python / python/editorial-board
For readers -- fix the doc links on python.org
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 14
- Forks
- 1
- Avg merge
- 59m
- Merged PRs (30d)
- 2
Description
The documentation tab on python.org is not very friendly:
Several links take you to this useless interstitial page: https://www.python.org/doc/ -- instead the tab should take you directly to https://docs.python.org/3/, or at the very least it should have a bold yellow button that takes you there (rather than a gray one).
Some other materials are seriously outdated or limited; the A/V link goes to a page with mostly outdated podcasts, for example (the list of recent PyCon talks is at the bottom). The Beginners link goes to a wiki page. Etc., etc.
- Link to discussion about the proposal (Discourse or GitHub): not yet
See also: https://docs.google.com/presentation/d/1ujDv8wViPvAMFAtYCRxSKh-CMUlbjcfVYitsqEI2Ios/edit#slide=id.p
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the documentation tab and the links described in this issue, especially /doc/ and https://docs.python.org/3/. Review the linked presentation and the A/V and Beginners destinations. Done means the tab reaches the current documentation directly and the identified outdated or limited materials have agreed-upon replacement links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100