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 天 7 分鐘
30 天內合併 PR
116

環境準備

  • 沒有 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 摘要。