WebAssembly / WebAssembly/wabt

Tech debt: keep mandoc html up to date

Open
#2,302 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
8.1k
Forks
827
Avg merge
4d 6h
Merged PRs (30d)
18

Description

This is an extension of #2301. However, this one is a bit harder - mandoc doesn't appear to have reproducible output, particularly around dates. Anyway, the relevant script is scripts/generate-html-docs.sh (which should really be .bash but anyway).

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 with scripts/generate-html-docs.sh and compare this task with issue #2301. Investigate how mandoc output, especially dates, prevents reproducible HTML generation. Done means the script keeps the generated mandoc HTML documentation up to date with reproducible output.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
build-system, documentation
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.