auto-generate docs
Open
Nobody has claimed this yet.
- Dominant language
- C
- Stars
- 200
- Forks
- 85
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 2
Description
Maybe the man pages can be generated from the code itself? In any case, we should attempt to unify the documentation in the --help command and in the man page.
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
Start by comparing the existing --help output with the man page across the file utilities to identify how each is currently produced. Determine whether a shared source or generation approach can keep both forms synchronized; done means the documentation is unified and the generated --help text and man page remain consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100