search

freedomjs / tutorial

Guide for getting started developing with freedom.js
http://www.freedomjs.org/tutorial/
2 stars 0 forks source link

Example code should be included inline and/or given stable/permanent links #4

Closed agallant closed 3 years ago

agallant commented 9 years ago

Many spots in the tutorial link to examples of code in GitHub repositories - these links should be made to refer to specific snapshots/versions so that the tutorial still makes sense after new commits are made. This is somewhat blocked on actually polishing Dorabella, but important to remember.

agallant commented 9 years ago

On further reflection, while I do think links to code is valuable (lets the reader see it in context), really important code blocks should likely all be included inline in the tutorial (so the reader doesn't need to break attention). We are somewhat targeting people who should feel comfortable tabbing between content so really both techniques are important and it's just a matter of balance (hence the issue re-titling).