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.