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.