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
I've gathered some site feedback from my coworkers and I feel some of them are worth sharing as a single ticket since they impact the reading experience when planned together. If you prefer I split these into separate tickets let me know.
Have tutorial pages link to respective docs
At the bottom of a tutorial page, add a 'read more' section that points to one or more relevant guides in the docs.
Have docs link to respective tutorials
Near the top of a guide or page, include a link to the respective tutorial page to help those get started hands on.
Have guides link to types
On a given guide, wherever types are mentioned, have them link to the respective type.
Example, these could be links to their types:
Provide a feature summary per guide
Some guides could benefit from a <table> or feature summary. For example when referencing form actions, it takes a bit of work to know the difference between use:enhance, applyAction, and update. A table could help as an addition to the explanation of those features, like so:
When supplying a function to use:enhance, its callback function behaviours are:
Somewhere on a given page, such as 'loading data' or 'form actions', provide a link farm or index that lists all related types so they can be looked up easily.
Optionally display inherited types
On a given types reference, display all inherited types or optionally hide them behind an accordion. For example, ServerLoadEvent extends RequestEvent and it would be useful to see the provided features of RequestEvent such as fetch or setHeaders while browsing ServerLoadEvent.
What's often the case is we're in VSCode previewing the event type for +page.server.js@load and we then look up the type for ServerLoadEvent only to hunt for all its types and features. Similarly, if a reader can jump from the "Loading Data" guide to ServerLoadEvent, then it may take some adjustment (or readjustment on a subsequent visit) to learn about its inherited properties.
The text was updated successfully, but these errors were encountered:
I've gathered some site feedback from my coworkers and I feel some of them are worth sharing as a single ticket since they impact the reading experience when planned together. If you prefer I split these into separate tickets let me know.
Have tutorial pages link to respective docs
At the bottom of a tutorial page, add a 'read more' section that points to one or more relevant guides in the docs.
Have docs link to respective tutorials
Near the top of a guide or page, include a link to the respective tutorial page to help those get started hands on.
Have guides link to types
On a given guide, wherever types are mentioned, have them link to the respective type.
Example, these could be links to their types:
Provide a feature summary per guide
Some guides could benefit from a
<table>
or feature summary. For example when referencing form actions, it takes a bit of work to know the difference betweenuse:enhance
,applyAction
, andupdate
. A table could help as an addition to the explanation of those features, like so:Also related: sveltejs/kit#11823
Provide a types index per guide
Somewhere on a given page, such as 'loading data' or 'form actions', provide a link farm or index that lists all related types so they can be looked up easily.
Optionally display inherited types
On a given types reference, display all inherited types or optionally hide them behind an accordion. For example,
ServerLoadEvent
extendsRequestEvent
and it would be useful to see the provided features ofRequestEvent
such asfetch
orsetHeaders
while browsingServerLoadEvent
.What's often the case is we're in VSCode previewing the event type for
+page.server.js@load
and we then look up the type forServerLoadEvent
only to hunt for all its types and features. Similarly, if a reader can jump from the "Loading Data" guide toServerLoadEvent
, then it may take some adjustment (or readjustment on a subsequent visit) to learn about its inherited properties.The text was updated successfully, but these errors were encountered: