redhat-developer / redhat-developer/vscode-yaml
Add support for markdown in property description
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- TypeScript
- Stars
- 829
- Forks
- 260
- Avg merge
- 5h 43m
- Merged PRs (30d)
- 1
Description
On completion and hover on a property, it would be great that displayed description is rendered using markdown renderer (based on "description" property in json schema),
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
The issue points to completion and hover rendering of a JSON Schema description; start by tracing those entry points and the existing markdown-renderer integration. Done means descriptions from the schema's "description" property render as Markdown in both completion and hover displays, with appropriate tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- json, markdown, typescript, vscode
- Domain
- devtools
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100