lundybernard/batconf

Cleanup Sphinx documentation

Open

#32 opened on Jul 27, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (3 forks)auto 404
good first issue

Repository metrics

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

Description

The documentation needs to be reviewed and cleaned up. Feel free to take on smaller tasks and open new Issues to track them.

Some things that need improvement:

  • Auto-generated API documentation
  • Add a detailed User Guide
  • Enable make docs from the project's root directory, so we don't need to cd into docs/

Contributor guide

Research direction
Review the existing Sphinx documentation, identify auto generated API docs and user guide gaps, and implement improvements as suggested.
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.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75