lbryio/lbry-sdk

Versioning for documentation to match daemon version

Open

#1,130 opened on Feb 26, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Python (500 forks)batch import
area: docsgood first issuehelp wantedlevel: 1type: discussiontype: improvement

Repository metrics

Stars
 (7,220 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Right now the docs correspond to what's on master. We need docs for each daemon release so developers can see what's available in the version they are using.

https://github.com/jimporter/mike may be helpful.

Contributor guide

Research direction
Investigate using mike to version documentation for each daemon release and integrate it into the existing documentation workflow.
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.
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
GitPythonDocumentation generation tools
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60