python / python/docs-community
Cut the whale of the changelog into manageable pieces?
Nobody has claimed this yet.
- Dominant language
- Makefile
- Stars
- 55
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
The changelog page is very long:
It's currently 219,974 words, that's longer than Moby Dick (212,794 words)... 🐳
It contains all the NEWS entries back to Python 3.5.0 alpha 1 (February 8, 2015).
It loads okay on deskstop, but my phone struggles to render it, and the browser hangs when trying to search for text.
I tried to check the accessibility report using Google's PageSpeed Insights:
It shows good initial numbers:
But the rest of the report is missing: "Oops! Something went wrong. generic::deadline_exceeded: Render timeout received in extension."
Shall we break the changelog page into smaller, more manageable chunks?
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 with the changelog page at https://docs.python.org/dev/whatsnew/changelog.html and investigate how its NEWS entries are assembled and published. Define a chunking approach that preserves the changelog history while improving mobile rendering, browser search, and accessibility, then verify the resulting pages with mobile performance checks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100