Component Documentation via Hover
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.3k
- Forks
- 41
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 16
Description
I was wondering if for Svelte 5 release you might consider Svelte Component documentation via hover. It turns out If you add JSDoc comments to component, then Svelte Extension takes over. This essentially gives you the docs within the IDE hover, as well as links to go to official docs. See Hunabyte Video. If you decide to implement this, see the comments regarding the purported fix for indentation.
Thank you again, this is a remarkable, powerful and super helpful library.
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
Read the linked Svelte FAQ and review the referenced comments about indentation before inspecting the repository's Svelte component sources. Confirm which components need JSDoc and verify that the resulting comments appear in Svelte Extension hover documentation with links to the official docs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100