DOCS: Rewrite AboutCode toolkit docs according to Diátaxis framework

Aberta
#46 1 comentário 0 reações 0 responsáveis Ver no GitHub

@NobleCoder69 já está trabalhando nisso.

Desde 15/12/2025.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
markdown
Domínio
documentation

Direção de pesquisa

A issue aponta para a documentação do toolkit AboutCode em aboutcode.readthedocs.io/projects/aboutcode-toolkit/ e para o framework Diátaxis; comece revisando a estrutura de documentação existente em relação ao framework. A tarefa estará concluída quando a documentação do toolkit tiver sido reescrita e organizada de acordo com o Diátaxis, e as páginas resultantes tiverem sido publicadas no site de documentação do projeto.

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

Descrição

documentation

Rewrite the documentation of AboutCode toolkit docs (see https://aboutcode.readthedocs.io/projects/aboutcode-toolkit/) according to Diátaxis framework to make the docs better.

Linguagem predominante
JavaScript
Estrelas
9
Forks
17
Merge médio
7h 55min
PRs com merge (30d)
2

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

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 aboutcode-org/www.aboutcode.org

Todas as issues de aboutcode-org/www.aboutcode.org

Issues semelhantes

Mais issues de JavaScript

Receba novas issues na sua caixa de entrada

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