xjsframework / xjsframework.github.io

XJS Framework website
http://xjsframework.github.io
1 stars 2 forks source link

Improve tutorial on sources #23

Closed mikeybanez closed 7 years ago

mikeybanez commented 8 years ago

I'm talking about this link http://xjsframework.github.io/tutorials.html#/sourceplugins

I know we modified a huge chunk of the tutorial because of the global sources feature, but at the moment, I think there is still a lot we can improve on. From a first-time developer's perspective, there are a lot of areas in the tutorial that don't make a lot of sense. Let's get our heads together and restructure the flow of the page.

A few checkpoints we can revisit:

I'll put this into milestone 1.5.0 as I think fixing this is a huge priority.

mikeybanez commented 8 years ago

Assigning to @SML-MeSo for now, but just feel free to reassign this to anyone.

mikeybanez commented 8 years ago

@SML-MeSo @virn I pushed a bunch of modifications to the tutorials, latest commit at 32cacd0.

There are a number of big changes there that are also related to xjsframework/xjs#111 --- you might want to take a thorough look at the docs. My original intention was to make the docs actually prescriptive of the direction we should take for 1.5.0, especially with how we are tackling the issue of a cleaner API for sources and items.

I also peppered a large number of TODOs in the tutorials; let's make sure to handle them all before release of the next version.