python / python/docs-community
Cut the whale of the changelog into manageable pieces?
还没有人认领这个 Issue。
- 主要语言
- Makefile
- 星标
- 55
- 派生
- 26
- PR 合并指标
- 30 天内没有已合并 PR
描述
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?
贡献指南
这个仓库没有索引到贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
从 https://docs.python.org/dev/whatsnew/changelog.html 的 changelog 页面开始,调查其中的 NEWS 条目是如何组装和发布的。定义一种 chunking 方案,在保留 changelog 历史记录的同时,改进移动端渲染、浏览器搜索和无障碍性,然后通过移动端性能检查验证生成的页面。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- python
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 25/100