Component Documentation via Hover
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- developer-experience, documentation
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.
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.
- Dominant language
- TypeScript
- Stars
- 1.3k
- Forks
- 41
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 14
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.
More from techniq/layerchart
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
techniq/layerchart#919 ·
-
tab freezes when an awaited value feeding a chart changes (async svelte + kit remote functions) Open
Difficulty 5/5 Over a week Newbie friendliness 35/100
techniq/layerchart#895 · 4 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 38/100
techniq/layerchart#876 · 3 reactions ·
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
techniq/layerchart#852 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 48/100
techniq/layerchart#830 · 1 comment ·
All issues in techniq/layerchart
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
calcite-components needs triage refactor
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
Esri/calcite-design-system#15203 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
fullcalendar/fullcalendar#8106 ·