guyzmo/git-repo

Write more thorough documentation

Open

#146 opened on Mar 21, 2017

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

Repository metrics

Stars
 (854 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Learn Sphinx documentation tool, explore the project structure, and start writing documentation for usage and internals, then upload to ReadTheDocs.
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.
Half day
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
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75