ndmitchell/shake

RFE: add a manpage for shake

Open

#106 opened on Apr 11, 2014

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Haskell (108 forks)batch import
help wanted

Repository metrics

Stars
 (631 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

I know there is documention including a manual and --help output, but distros like Debian and Fedora like to have manpage for installed programs.

Is it possible to add a manpage shake (1) to the distribution? I think pandoc is able to generate them from markdown.

If the manpage could be generated from "shake --help" somehow perhaps it would be less work to keep in sync.

Contributor guide

Research direction
Examine the current documentation generation process (likely using Make or similar) and identify where to add a manpage target. Use pandoc to convert the existing markdown documentation to a manpage format. Ensure the manpage is installed correctly in the build system.
Tech stack
haskell
Domain
build system
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Haskellpandoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75