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
The process of managing, updating, and deploying code examples with the REPL is quite fragile and cumbersome.
A simple developer API for managing project examples and deploying them to the REPL would be nice. It should also provide a unified experience for Svelte package developers to provide
Features
Ideally, we would want certain features to streamline the process of building documentation examples.
Let users specify a project folder on the REPL to store all examples for a given project (this would require an extension to the REPL for folders)
Generate an access token to allow writes to the project folder for CI / CD.
Configure the documentation project to specify the project ID.
Write code examples as Svelte files with some metadata to specify the example ID, Svelte environment, REPL title, etc.
We could even automatically resolve imports to include all the required files for an example
Provide a custom store / component that gets a link to the correct REPL when given the example ID, which the user can then embed in their documentation
This could even be a re-direct link in the format of svelte.dev/repl/{project-id}/{example-id}
Provide CI tools to deploy code examples onto the REPL
Benefits
It encourages Svelte package developers to more readily provide code examples due to the accessibility of the REPL. In the long run, it should improve the Svelte ecosystem.
Potential issues
Given the niche applicability of the use case, the added complexity to the REPL might not be warranted.
This may also not be in the spirit of the REPL, as it should be a simple playground to try new Svelte things. However, the complexity should be completely hidden to average users and the end experience should remain simple.
The text was updated successfully, but these errors were encountered:
The process of managing, updating, and deploying code examples with the REPL is quite fragile and cumbersome.
A simple developer API for managing project examples and deploying them to the REPL would be nice. It should also provide a unified experience for Svelte package developers to provide
Features
Ideally, we would want certain features to streamline the process of building documentation examples.
svelte.dev/repl/{project-id}/{example-id}
Benefits
It encourages Svelte package developers to more readily provide code examples due to the accessibility of the REPL. In the long run, it should improve the Svelte ecosystem.
Potential issues
Given the niche applicability of the use case, the added complexity to the REPL might not be warranted.
This may also not be in the spirit of the REPL, as it should be a simple playground to try new Svelte things. However, the complexity should be completely hidden to average users and the end experience should remain simple.
The text was updated successfully, but these errors were encountered: