DOCS: Create AboutCode doc system
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 5/5
- Tempo estimado
- Mais de uma semana
- Facilidade para iniciantes
- 30/100
- Tipo de issue
- Documentação
- Clareza
- Precisa de esclarecimento
- Status de atividade
- Estagnada
- Stack de tecnologia
- javascript, markdown
- Domínio
- documentation
Direção de pesquisa
Comece revisando a documentação existente em aboutcode.readthedocs.io/ e o framework Diátaxis vinculado na issue. Defina a estrutura proposta e as orientações para a documentação do projeto, os arquivos README, os arquivos CONTRIBUTING e as descrições dos repositórios; considera-se concluído quando o sistema de documentação estiver publicado e explicar como os projetos AboutCode devem aplicá-lo.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
To improve and standardize the documentation across AboutCode projects, we plan to implement a documentation system on https://aboutcode.readthedocs.io/. This system will consist of pages inspired by the Divio documentation system, which explains the Diátaxis framework and its application to AboutCode projects.
Beyond outlining how project docs should be structured it the docs system should also provide guidance on README, CONTRIBUTING and repository descriptions.
- 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
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de aboutcode-org/www.aboutcode.org
-
Making all post button.Talvez já em andamento @sarthaklole assumiu há 71 dias. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
aboutcode-org/www.aboutcode.org#117 · 3 comentários ·
-
WWW: Reduce frequency of update-releasesTalvez livre de novo @johnmhoran assumiu há 52 dias e não há nenhum pull request aberto. Abertaci-workflow
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 45/100
aboutcode-org/www.aboutcode.org#180 · 1 responsável ·
-
DOCS: Create new AboutCode stack diagram(s)Talvez livre de novo @hixvikas assumiu há 54 dias e não há nenhum pull request aberto. Abertadocumentation
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 35/100
aboutcode-org/www.aboutcode.org#166 · 1 comentário ·
-
WWW: Create About top level page?Talvez já em andamento @pombredanne assumiu há 155 dias. Abertawebsite
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 35/100
aboutcode-org/www.aboutcode.org#164 · 1 reação · 1 responsável ·
-
WWW: Add Initiatives and grant ProjectsTalvez livre de novo @mjherzog assumiu há 242 dias e não há nenhum pull request aberto. Abertaenhancement needs design website
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
aboutcode-org/www.aboutcode.org#141 · 1 responsável ·
Todas as issues de aboutcode-org/www.aboutcode.org
Issues semelhantes
-
Let TypeScript accept an initial object in ReactiveDictTalvez já em andamento @yograj-vijay-yadav assumiu hoje. Abertabug good first issue help wanted workshop
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 92/100
meteor/meteor#14919 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
akitaonrails/FrankMD#268 ·
Mantenedores costumam responder em até 1 dia
-
account: profile
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Mantenedores costumam responder em até 5 dias
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 82/100
mfreed7/xslt_polyfill#65 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
Mantenedores costumam responder em até 1 dia