Use ronn-ng to generate the documentation
Open
Nobody has claimed this yet.
suspend
- Dominant language
- Shell
- Stars
- 18.1k
- Forks
- 1.2k
- Avg merge
- 5d 17h
- Merged PRs (30d)
- 1
Description
Currently we are using ronn to convert markdown docs to man pages and html files. Ronn is not longer maintained so we want to use ronn-ng instead.
There are two blocking issues about ronn-ng:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the existing ronn-based documentation generation setup and the two linked ronn-ng issues first, since they are listed as blockers. Done means ronn-ng replaces ronn while still producing the project's Markdown-derived man pages and HTML files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- build-system, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100