Canop / Canop/broot

Automate man page creation

Open
#418 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
12.9k
Forks
315
Avg merge
1d 6h
Merged PRs (30d)
6

Description

broot's man page should be easily kept synchronized with the code base. It seems clap doesn't have relevant features yet.

Contributor guide

Open the contributing guide

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 locating broot's current man page and the clap command-definition entry point, then compare how the documentation relates to the code base. Determine whether clap provides a suitable generation path; done means the man page can be regenerated or kept synchronized without manual drift.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.