crisishistory/HistoryAIToolkit

Improve "Getting Started" instructions

Open

#44 ouverte le 4 oct. 2023

Voir sur GitHub
 (4 commentaires) (0 réactions) (0 assignés)Python (18 forks)github user discovery
documentationhacktoberfest-acceptedhelp wanted

Métriques du dépôt

Stars
 (13 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Déplacez la section 'Pour commencer' de README.md vers un nouveau fichier dans docs/ (par exemple docs/getting started.md). Mettez à jour toutes les références : README.md, CONTRIBUTING.md et la page d'index de ReadTheDocs (docs/index.rst ou similaire). Vérifiez les liens et testez les instructions.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85