WebAssembly / WebAssembly/wabt
Tech debt: keep man pages up to date
Open
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 8.1k
- Forks
- 827
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 18
Description
There is a script, scripts/help2man.lua which can be used to generate manpages from $wabt_tool --help output. It could be used in CI to fail if man pages are outdated.
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 reading scripts/help2man.lua and inspecting the repository's existing man pages and CI configuration. Run the generator against the wabt tools' --help output to understand its inputs and outputs. Done means CI detects and fails when generated man pages differ from the committed versions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, lua
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100