crisishistory/HistoryAIToolkit

Improve "Getting Started" instructions

Open

#44 aberto em 4 de out. de 2023

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Python (18 forks)github user discovery
documentationhacktoberfest-acceptedhelp wanted

Métricas do repositório

Stars
 (13 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

  • Move the getting started section from the readme into its own file in the docs folder
  • Link to the new getting started file in the docs folder once created, from other places that reference it:
  • Try them out and make corrections as needed

Guia do colaborador

Direção de pesquisa
Mova a seção 'Introdução' do README.md para um novo arquivo em docs/ (exemplo: docs/getting started.md). Atualize todas as referências: README.md, CONTRIBUTING.md e a página de índice do ReadTheDocs (docs/index.rst ou similar). Verifique os links e teste as instruções.
Pilha de tecnologia
python
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85