lbryio/lbry-sdk

Versioning for documentation to match daemon version

Open

#1,130 创建于 2018年2月26日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Python (7,220 star) (500 fork)batch import
area: docsgood first issuehelp wantedlevel: 1type: discussiontype: improvement

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
MkDocsPythonSemantic versioning
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
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.