runtimeverification / runtimeverification/kontrol
Generate complete default `kontrol.toml` automatically using `kontrol config` like the `foundry config`.
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 122
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
Motivation
Requirement from KaaS to obtain the option information for each version of Kontrol; Freeman's comment:
Thinking about it a bit, if it was published in a json format, or YAML it would be super easy to parse, and we could setup a modular views that just consume the latest publish kontrol version of it.
This way it could provide the entire parameter and options list + descriptions for each which can be auto populated from a published source direct from kontrol to kaas
Possible Solution
- generete these informations in json
- use this json file generate a description for kontrol.toml / all kontrol options. (4 Kontrol Documentation)
- Store the json file to somewhere for Kaas to access.
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 the kontrol config entry point and reviewing how foundry config generates its complete configuration. Trace where Kontrol option names and descriptions are defined, then determine how to produce the JSON source and use it for a complete kontrol.toml; done means the generated data includes all options and can be accessed by KaaS.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100