Documentation rework

未关闭
  • 哪里不对？
#16,532 0 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
25/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
python
领域
documentation

调研方向

Start with CONTRIBUTING.md, the file the issue calls the worst offender, and the METADATA.toml section inside it that should move out. The other files in scope are README.md, MAINTAINERS.md, tests/README.md, tests/REGRESSION.md and stdlib/_typeshed/README.md. Agree the new docs/ layout with the maintainers before editing, since the author calls the plan unfinished. Done means docs/README.md exists and is linked from README.md and CONTRIBUTING.md, and the split files are in place.

由索引模型根据 Issue 内容生成。

描述

project: documentation

(See below for explanation.)

  • Add docs/README.md as documentation index; link to it from README.md and CONTRIBUTING.md ("Further Documentation") (#16579)
  • Split MAINTAINERS.md into docs/maintainers.md (maintainers list) and docs/maintainer-guide.md (information for maintainers) (#16636)
  • Integrate some information from CONTRIBUTING.md into docs/maintainer-guide.md
  • Rework/review README.md
  • Rework/review MAINTAINERS.md
  • Rework/review CONTRIBUTING.md
    • Split metadata documentation into own file; keep brief description and required fields
  • Rework/review tests/README.md
  • Rework/review tests/REGRESSION.md
  • Rework/review stdlib/_typeshed/README.md
  • Add a "stub conventions" documents; should mostly refer to Writing and Maintaining Stub Files, but include our own additional guidelines
    • Add DSL policy (i.e. how we annotation object.__eq__ and other base methods that may be used by DSLs in non-standard ways)

Over the years typeshed has accumulated a lot of documentation. Most of it is still useful, but it could be better structured to help new users, experienced users, and maintainers alike to find the information they are looking for. For example, probably the worst "offender" is our contributing document. This is mainly a document for new users (and should ideally be read in its entirety), but contains a lot of arcane information, for example about the intricacies of the METADATA.toml format. It doesn't help that every change will create a popup "contributing has changed" for every user when creating a PR.

The list above is just a bunch of initial ideas I have, and is by no means complete or set in stone. I've also written "review/rework" for basically every existing document. This doesn't mean that all documents need changes, but we should at least have a look at them to confirm that.

I've also created a new label "project: documentation" exclusively for documentation-related issues and PRs.

I'm not sure that I can dedicate how much time I can dedicate to this myself in the foreseeable, but I wanted to at least write down my current ideas and have a "hub" to refer back to later.

主要语言
Python
星标
5.1k
派生
2.1k
平均合并
2 天 1 小时
30 天内合并 PR
115

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

python/typeshed 的其他 Issue

查看 python/typeshed 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。