svelte icon indicating copy to clipboard operation
svelte copied to clipboard

docs improvements

Open benmccann opened this issue 1 year ago • 3 comments

Describe the problem

implement suggestions from #ambassadors

Describe the proposed solution

  • untrack
  • how to use interfaces with $props
  • how to type a component (ReturnType<typeof Component>)
  • links between tutorial and docs

Importance

nice to have

benmccann avatar Oct 31 '24 01:10 benmccann

I would add "how to type and forward props to html elements", probably under the $props interface thing.

rChaoz avatar Oct 31 '24 12:10 rChaoz

Don't know if this has been done or where to even mention this or if it has been mentioned.

In the docs, can we mention the "docstring/jsdoc/sveltedoc" feature:

<!--@component
	This component can do things
-->
<script>
 // svelte code
</script>

<div>I can do things</div>

Seems like a best kept secret.

shivan-s avatar Oct 31 '24 20:10 shivan-s

I just found https://github.com/sveltejs/svelte.dev/issues/747, which also mentions a lot of these issues

benmccann avatar Nov 06 '24 19:11 benmccann