jesp1999/heckbot

Add documentation generator integration

Offen

#57 geöffnet am 04.02.2023

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (4 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (2 Sterne)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

Either Sphinx, readthedocs, or Mkdocs will work. Slight preference towards readthedocs but I'm open to trying new things.

Sphinx startup: https://www.sphinx-doc.org/en/master/usage/quickstart.html Mkdocs startup: https://www.mkdocs.org/getting-started/ Readthedocs startup: https://docs.readthedocs.io/en/stable/tutorial/

Contributor Guide

Research-Richtung
Wähle eines von Sphinx, Mkdocs oder Readthedocs aus und folge dessen Startanleitung, um es für dieses Python Projekt zu konfigurieren. Konzentriere dich auf die Generierung von Dokumentation aus Docstrings oder das Schreiben neuer Dokumentation.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90