runtimeverification / runtimeverification/haskell-backend
Update SMT encoding documentation
Open
Nobody has claimed this yet.
cleanup
documentation
- Dominant language
- Haskell
- Stars
- 224
- Forks
- 43
- PR merge metrics
- No merged PRs in 30d
Description
The SMT encoding documentation needs to be updated:
- upstream, and
- in the design decisions by making a document which reflects the current state of SMT encoding.
Contributor guide
No contributing guide indexed for this repository
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 pending-documentation.md at the linked SMT lemma section and design-decisions/2018-11-05-Translating-predicates.md. Compare both documents with the current SMT encoding, then update the upstream documentation and add a design document that reflects the current state; done means both requested documentation areas are current.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100