Skip to content
Please note that GitHub no longer supports your web browser.

We recommend upgrading to the latest Google Chrome or Firefox.

Learn more
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Examples need documentation #3920

Open
rlaferla opened this issue Nov 13, 2019 · 1 comment
Labels

Comments

@rlaferla
Copy link

@rlaferla rlaferla commented Nov 13, 2019

Some of the examples on the Svelte website are straightforward/intuitive but others need some explanation/documentation. For example, the "Deferred transitions" example is excellent but there are a lot of things going on and it's difficult to understand. In particular, what is the essential lesson of the example vs. understanding all the code needed to demonstrate it.

Therefore, I recommend:

  • Review of each example
  • Adding a README file to each example. Perhaps a README.svelte file could be added to each example.
  • Adding more comments to each example.

e.g.

App.svelte

<script>
	import README from './README.svelte';

	let name = 'world';
</script>


<README />

<h1>Hello {name}!</h1>

README.svelte

<hr>
<h1>
	README - Hello world
</h1>

This example shows how a variable in the script section can be used in a HTML template.

image

@Conduitry Conduitry added the docs label Nov 14, 2019
@beinoriusju

This comment has been minimized.

Copy link

@beinoriusju beinoriusju commented Nov 19, 2019

Having been introduced to terms interpolate and interpolation my understanding of how Svelte animation library works grew. Maybe they should be mentioned more often in documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.