guyzmo/git-repo

Write more thorough documentation

Open

#146 opened on Mar 21, 2017

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (837 stars) (86 forks)batch import
enhancementgood first issuehelp wanted

Description

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

Contributor guide

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.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Set up Sphinx documentation structure in the project, create a proper manual for usage and a manpage, document internals, and configure Read the Docs integration. Refer to similar Python projects' documentation for structure and content.