redhat-developer / redhat-developer/vscode-xml
Add Documentation for the XML Extension TypeScript API
Open
Nobody has claimed this yet.
documentation
- Dominant language
- TypeScript
- Stars
- 328
- Forks
- 101
- Avg merge
- 1d 17h
- Merged PRs (30d)
- 7
Description
In Extensions.md, as of PR #340, we reference a specific merged PR for documentation on the TypeScript API for extending LemMinX.
I think it would be a good idea to update Extensions.md in order to better explain the API, and link to the documentation of the API.
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 docs/Extensions.md and review the reference to PR #340. Read the linked TypeScript API documentation for extending LemMinX, then update Extensions.md with a clearer API explanation and a link to that documentation. Done means the extension documentation explains the API and no longer relies only on the merged PR reference.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100