leanprover / leanprover/reference-manual
Traceability of artifacts
Nobody has claimed this yet.
- Dominant language
- Lean
- Stars
- 129
- Forks
- 67
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 16
Description
It should be easy to look at a generated artifact and determine its provenance.
I propose that we insert an HTML comment in each HTML file, just before <html>, of the form:
<!-- Generated from tag 'v4.XX.YY' revision 'SHA' at TIMESTAMP -->
This avoids readers seeing it, but makes it easier to track exactly where things came from. Something like this was requested by @nomeata.
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
No files or tests are named. Start by locating the reference manual's HTML generation entry point and determine how the release tag, revision, and timestamp are available there. Done means every generated HTML file contains the specified provenance comment immediately before the element, with a test or inspection confirming the output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100