Documentation rework

Aberta
  • Algo errado?
#16,532 0 comentários 1 reação 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
4/5
Tempo estimado
3-5 dias
Facilidade para iniciantes
25/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Python
Estrelas
5.1k
Forks
2.1k
Merge médio
2d 1h
PRs com merge (30d)
115

Preparar o ambiente

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de python/typeshed

Todas as issues de python/typeshed

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.