You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
More repos are now part of the Svelte org, like svelte-preprocess (cc @kaisermann ) or language-tools. Some of these repos - like the two mentioned - have extensive documentation which is not easily discoverable if you don't know what to search for. This makes it hard for beginners to get started when e.g. wanting to use preprocessors.
Describe the solution you'd like
Add a new section "Docs" on the official Svelte site which contains the documentation of all official repos where it makes sense. A proposal:
IDEs: the docs of language-tools to know how to setup advanced configs when using the VSCode extension; and pointers to Svelte extensions in other IDEs
Integrations: The list of the integrations repo
Preprocessing: The docs of svelte-preprocess
Build: Docs on rollup-plugin-svelte and svelte-loader
It would be great to have some specific "wrapper"/introductionary docs for the site and other than that just copy over the docs of the existing repos through a script, if possible. Docs can be tidied up in the process.
How important is this feature to you?
Important, as I think this will boost the onboarding experience and overall discoverability.
The text was updated successfully, but these errors were encountered:
Maybe it would be interesting to define a standardized way to write the documentation of these tools 🤔 . Possibly something similar to the one's already in svelte.dev?
Yes I think this makes sense. We would need to agree on some syntactic/semantic standard and then edit the docs accordingly. I also think this will be an iterative process.
What I would like to avoid is moving the docs in the the main repo, so some script that copies stuff over and knows the locations of the docs by some conventention would be nice. An alternative would be some kind of JSON that lives at a defined position within the repo which tells the script where to get the docs from and how to assemble them.
Is your feature request related to a problem? Please describe.
More repos are now part of the Svelte org, like
svelte-preprocess
(cc @kaisermann ) orlanguage-tools
. Some of these repos - like the two mentioned - have extensive documentation which is not easily discoverable if you don't know what to search for. This makes it hard for beginners to get started when e.g. wanting to use preprocessors.Describe the solution you'd like
Add a new section "Docs" on the official Svelte site which contains the documentation of all official repos where it makes sense. A proposal:
IDEs
: the docs oflanguage-tools
to know how to setup advanced configs when using the VSCode extension; and pointers to Svelte extensions in other IDEsIntegrations
: The list of the integrations repoPreprocessing
: The docs ofsvelte-preprocess
Build
: Docs onrollup-plugin-svelte
andsvelte-loader
It would be great to have some specific "wrapper"/introductionary docs for the site and other than that just copy over the docs of the existing repos through a script, if possible. Docs can be tidied up in the process.
How important is this feature to you?
Important, as I think this will boost the onboarding experience and overall discoverability.
The text was updated successfully, but these errors were encountered: