jesp1999/heckbot

Add documentation generator integration

Open

#57 opened on Feb 4, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (4 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (2 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Choose one of Sphinx, Mkdocs, or Readthedocs, then follow its startup guide to configure it for this Python project. Focus on generating documentation from docstrings or writing new documentation.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90