runtimeverification / runtimeverification/kontrol
Updates to Kontrol Documentation
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 122
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Pulled partially from: https://github.com/runtimeverification/kontrol/issues/977
- How to use kontrol prove ... --lemmas LEMMAS-FILE:LEMMAS-MODULE (renamed from --extra-module).
- How to know when to rekompile or not (currently we recommend to rekompile when solidity code changes: https://github.com/runtimeverification/kontrol/pull/1007#discussion_r2014193727).
- Command
kontrol solc-to-kdoes not exist anymore, but is in the Kontrol Arguments sheet: https://docs.runtimeverification.com/kontrol/glossary/kontrol-arguments - Command
kontrol compilemay not exist anymore, given: https://github.com/runtimeverification/kontrol/pull/1019 - Command
kontrol to-dotmay not exist anymore, given: https://github.com/runtimeverification/kontrol/pull/1019 - How
--run-constructoris used: https://github.com/runtimeverification/gitbook-kontrol/issues/31
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 with the Kontrol Arguments page and the referenced PRs and issues, then check each listed command and option against the current documentation. Done means the prove lemmas syntax, rekompile guidance, command removals, and --run-constructor usage are accurate and consistently documented.
Written by the indexing model from the issue text.
Assessment
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100