Public cookbook

[sglanzer]

Awesome addon, this is really going to push the professionalism of Ember addons forward lightyears!

One of the things I've always enjoyed using to help colleagues with more complex concepts is ember-twiddle. Browsing through D3 examples the other day it occurred to me that it would be incredibly useful to have a publicly contributeable cookbook section in the docs of ember addons that linked to twiddles tagged with the addon.

I'm not sure what mechanisms are in place to support something like this but I'm sure that twiddles would be a welcome avenue of contribution for some people.

[samselikoff]

Thanks for the kind words!

Regarding the feature request, this is the sort of thing I'd like to see extracted from some real docs sites once people start making them.

Right now if you look at the nav

you'll see that there's a contextual component (nav.section) that let's you create these section headers ("Introduction", "Components" etc.) and that would be a perfect way to add a "Cookbook" section. I might even start with a Cookbook page near the top of the docs that is just a Markdown doc with links to twiddles.

What would be cool one day is if Twiddles could be embedded. That would be a really neat feature and I could see adding an API to define those + autobuild part of the site, similar to how we do for the API section.

[pzuraq]

Worth noting that this may be the perfect use of the Sandbox as well, we can show off (and test) advanced techniques

[dfreeman]

If it winds up being a large enough collection of 'recipes', we could even consider adding Cookbook as a peer to the Sandbox

[samselikoff]

@dfreeman yep, love that. Top-level nav gives us some flexibility here

[sglanzer]

@dfreeman I could see that, especially for libraries like liquid-fire or ember-concurrency where there are tons of potential applications of the addon

@pzuraq I think part of the appeal for me is that this would be only lightly curated (e.g. ranked by saved gist stars?) so that the section could grow without a need to directly accept a PR, which I believe would be required for the Sandbox (please correct me if that's not the case/intention)

[pzuraq]

Ah I'm sorry, misunderstood the issue! I thought you were asking for us to add a cookbook just for addon docs, that's what I get for just reading the title 😛

Sounds like it would be a great feature, I definitely think it would help increase learnability of Ember in general if there was a way for people to share recipes without having to make a PR. Definitely on board with this idea