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

Documentation - way to contribute and consume real-world code examples, cookbook #321

Open
revelt opened this issue Oct 3, 2017 · 1 comment

Comments

@revelt
Copy link

revelt commented Oct 3, 2017

hi guys,

I know Sindre prefers to have Wiki's turned off, but currently there are not only no real-world examples (in my opinion at least), but there is not even a way to share code examples with others. Commonly wiki's usually perform that role, but it's turned off here.

I'm tinkering with Gulp and pageres and seemingly elementary things take quite some time to set up. It would be nice if somebody compiled the most common cases. You wouldn't start from scratch each time.

For example, I've got bunch of folders with one HTML file in each. I want to prepare two screenshots and place them besides the HTML - full size screenshot and a thumbnail. It's going slow to assemble this and I'd be happy to share the Gulp task with others once I nail that. Now, if I put that in my blog, peeps won't find it as much compared if it was placed here. Extending Readme is also not an option, it will be cramped soon.

Consider some way to let community contribute code examples.

cheers

@sindresorhus sindresorhus changed the title documentation - way to contribute and consume real-world code examples, cookbook Documentation - way to contribute and consume real-world code examples, cookbook Oct 3, 2017
@sindresorhus
Copy link
Owner

Wiki's are bad as anyone can add and edit anything without proper review. I would be happy to accept good recipes though. Could be in a recipes folder in the repo and linked to from the readme.

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

No branches or pull requests

2 participants