search

know-cujojs / know

Know cujoJS through these short, focused tutorials
Other
5 stars 5 forks source link

Decide on some standard "boilerplate" for the bottom of each tutorial? #4

Closed unscriptable closed 11 years ago

unscriptable commented 11 years ago

I put this at the bottom of each of my tutorials:

For more cujo.js tutorials, go to http://know.cujojs.com/.

To get started with cujo.js asap, clone it or download it at http://github.com/cujojs/quickstart/.

Does this work? Any suggestions? Maybe the website generator should add this?

briancavalier commented 11 years ago

Seems like a good idea. If there was a way we didn't have to maintain it individually for every tutorial, that'd be even better :)

scothis commented 11 years ago

I'd rather put this in the readme once than duplicate it everywhere. Once we serialize the markdown to html, we can include something in the footer of each post easily. It's safe to assume that people reading on GitHub understand how GitHub works.

unscriptable commented 11 years ago

OK, let's plan to add some boilerplate to the generated html.

briancavalier commented 11 years ago

I'd rather put this in the readme once than duplicate it everywhere. Once we serialize the markdown to html, we can include something in the footer of each post easily.

I think some people will find the footer links to be helpful, so yeah, I'm all for automating it via whatever means we decide to render the tutorials to html.

It's safe to assume that people reading on GitHub understand how GitHub works.

Not sure if that's applicable here (?) since the boilerplate @unscriptable suggested points to other cujo resources, not to say, an issues list or somesuch.

unscriptable commented 11 years ago

It's safe to assume that people reading on GitHub understand how GitHub works. Not sure if that's applicable here (?) since the boilerplate @unscriptable suggested points to other cujo resources, not to say, an issues list or somesuch.

I think what @scothis said will be more applicable once the web site is up. We should definitely maximize linkage between this repo and cujojs within the README as well as within the tutorials. I've been using cujo.js libs in my code samples and linking to the related repos if I can find a way.

unscriptable commented 11 years ago

Seems like this is done, too?