crisishistory/HistoryAIToolkit

Improve "Getting Started" instructions

Open

#44 aperta il 4 ott 2023

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)Python (18 fork)github user discovery
documentationhacktoberfest-acceptedhelp wanted

Metriche repository

Star
 (13 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

  • 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

Guida contributor

Direzione di ricerca
Sposta la sezione 'Per iniziare' da README.md in un nuovo file in docs/ (es. docs/getting started.md). Aggiorna tutti i riferimenti: README.md, CONTRIBUTING.md e la pagina dell'indice di ReadTheDocs (docs/index.rst o simile). Verifica i collegamenti e testa le istruzioni.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85