Skip to content
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

Improving docs / adding snippets #56

Open
ff6347 opened this issue Jul 18, 2016 · 1 comment
Open

Improving docs / adding snippets #56

ff6347 opened this issue Jul 18, 2016 · 1 comment
Labels
Milestone

Comments

@ff6347
Copy link
Member

ff6347 commented Jul 18, 2016

As mentioned in #50 Would be great to have more examples. Even better would be to have simple "copy & pasteable" code snippets in the docs

@ff6347 ff6347 added the feature label Jul 18, 2016
@ff6347 ff6347 added this to the Documentation milestone Jul 18, 2016
@ff6347 ff6347 changed the title More examples in bundle and docs Improving docs / adding snippets Jul 18, 2016
@ff6347
Copy link
Member Author

ff6347 commented Jul 22, 2016

Stackoverflow is launching a new section called "Documentation" http://stackoverflow.com/tour/documentation What I found interesting about it is (besides al that other good stuff):

It's all about examples.

Examples illustrate common tasks or solutions to common problems - remember "Show, Don't Tell". A good example is self-contained and succinct, and more often than not contains code. It is more important that code in examples be illustrative and focused than that it be copy/paste-able; leave out boilerplate when it distracts from the concept the example is meant to illustrate.

leave out boilerplate when it distracts from the concept the example is meant to illustrate.

It is something to think about.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant