Enable view of rendered YAML to include JSON schema
Open
Nobody has claimed this yet.
Issue-Enhancement
- Dominant language
- Rust
- Stars
- 523
- Forks
- 75
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 24
Description
Summary of the new feature / enhancement
To help users understand the resulting YAML better (without going to webpage or man page), we could take descriptions of JSON members from the JSON schema and put those as comments into the YAML.
Proposed technical implementation details (optional)
May make sense to have a switch to suppress assuming most people want to see it to explain what properties do but there could be lots of description being emitted.
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 code path that renders YAML and the JSON schema data it can access. Determine how schema member descriptions could become YAML comments, then verify that rendered output includes those descriptions and that any agreed suppression switch behaves as intended.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100