brndnmtthws/conky

Improve documentation handling

Open

#762 建立於 2019年1月10日

在 GitHub 查看
 (6 留言) (0 反應) (0 負責人)C++ (6,472 star) (604 fork)batch import
documentationgood first issuehelp wanted

描述

I'd like to convert the documentation from a XML/XSL-based system, to a simpler JSON/Jekyll/Jinja2 based system. I would also like to use GitHub pages to provide a landing page with documentation for Conky.

貢獻者指南

技術棧
無
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
3-5 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Familiarity with JekyllGitHub Pages experience
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
Start by exploring the current documentation build system in the repository, looking at the XML/XSL files and any related scripts (e.g., Makefile). Then research Jekyll and GitHub Pages to understand how to structure the new documentation. Review any existing discussions in the issue comments for additional context. Consider creating a prototype or a pull request to gather feedback.