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 (7,220 stars) (500 forks)batch import
area: docsgood first issuehelp wantedlevel: 1type: discussiontype: improvement

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

Tech stack
python
Domain
documentation
Issue type
feature
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.
1-2 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
MkDocsPythonSemantic versioning
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate how to integrate mike (a mkdocs plugin for versioning) into the existing documentation workflow found in the repository, likely in a 'docs' directory. Look at how the documentation is currently built and deployed. Determine the process to create versioned documentation for each daemon release. Consider using GitHub Actions to automate builds. Check existing comments in issue #1130 for any additional context or suggestions.