brndnmtthws/conky

Improve documentation handling

Open

#762 opened on Jan 10, 2019

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C++ (604 forks)batch import
documentationgood first issuehelp wanted

Repository metrics

Stars
 (6,472 stars)
PR merge metrics
 (Avg merge 13d 5h) (26 merged PRs in 30d)

Description

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.

Contributor guide

Research direction
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.
Tech stack
None
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.
3-5 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
Familiarity with JekyllGitHub Pages experience
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30