rocq-prover / rocq-prover/platform-docs
Switch from coqdoc to alectryon
Open
Nobody has claimed this yet.
Web Interface
- Dominant language
- Rocq Prover
- Stars
- 26
- Forks
- 25
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 1
Description
Currently, we are using coqdoc to process .v file to htlm page, which are then turned interactive with JsCoq.
The goal is to change from coqdoc to Alectryon. Among others, to support reStructured text.
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 locating how coqdoc processes .v files into HTML pages and how JsCoq makes them interactive. Compare that pipeline with Alectryon, including its reStructuredText support; the work is done when the documentation is generated through Alectryon and remains interactive.
Written by the indexing model from the issue text.
Assessment
- Domain
- build-system, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100