Marak / Marak/xp

Create man page and html documentation using ronn

Open
#1 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CoffeeScript
Stars
32
Forks
1
PR merge metrics
No merged PRs in 30d

Description

https://github.com/rtomayko/ronn

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the ronn documentation linked in the issue and inspecting the xp repository for its existing command documentation or entry points. Done means adding a man page and generated HTML documentation for xp using ronn, with the intended source location and generation steps documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
coffeescript
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.