rocq-prover / rocq-prover/stdlib
definition of field and ring theories excluded from standard library reference main page
Nobody has claimed this yet.
- Dominant language
- Rocq Prover
- Stars
- 42
- Forks
- 38
- Avg merge
- 14h 6m
- Merged PRs (30d)
- 3
Description
All files under the setoid_ring folder are excluded from the standard library documentation (that is mentioned in (https://github.com/coq/coq/blob/master/doc/stdlib/hidden-files)). I find this decision questionable since the concept of ring and field are quite central and I don't see why one shouldn't be able to search for ring or field in the standard library main page (https://coq.inria.fr/library/).
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 doc/stdlib/hidden-files and checking how the setoid_ring folder is represented in the standard library documentation. Confirm how the main library page is generated, then make the setoid_ring definitions searchable there and verify that the documentation includes them.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100