GSoC application for BoneScript web pages with live-running examples and documentation

Google Summer of Code
1

This is draft of my proposal. Still working on it.
I will like your feedback.
https://docs.google.com/document/d/1upM9jy76y6Y4eOPl_Yt7uWI-S_gEGTedDLcQRDvuZ8U/edit?usp=sharing

Thanks in advance
Diego

2

This is draft of my proposal. Still working on it.
I will like your feedback.
https://docs.google.com/document/d/1upM9jy76y6Y4eOPl_Yt7uWI-S_gEGTedDLcQRDvuZ8U/edit?usp=sharing

Thanks for posting this and I’ll get to marking it up with some comments.

Note, I was able to find some documentation on showing Gists on JSFiddle at http://doc.jsfiddle.net/use/gist_read.html. Here’s a BoneScript-based example of the integration: BoneScript Flot Demo - JSFiddle - Code Playground.

I really like Adam Flaherty’s idea of putting each of these demos in “cards”. The JSFiddle integration with Gist gives me some ideas on the wizards that doesn’t quite eliminate some of the functionality of a tool like http://khanacademy.com/cs/programming or http://codecademy.com, but would likely give us enough regularity to the data that we could make it import into anything we might create.

One part of the ideas that come to my mind is to name files within the Gist something like “bone101.manifest”, “step1.{html|js}”, “step2.{md|png|fzz}”, etc. An ‘fzz’ file would be a Fritzing diagram and the ‘png’ would be the rendering.

What do you think about putting the tutorials in this type of format? What issues do you believe it will create?

3

Hi Jason
I like the idea.
But what do you think of still use the same wizard I have in the mockup for creating the documentation and the when the users are going to read the documentation they can see it in cards?

4

Hi Jason
I like the idea.
But what do you think of still use the same wizard I have in the mockup for
creating the documentation and the when the users are going to read the
documentation they can see it in cards?

I think a first-pass implementation where editors would edit a
gist-fork of a card would be sufficiently easy for most contributors.
Do you feel only an authoring wizard (in addition to a user wizard) is
the only way it can be editable?

Can you reshare your mockup?

5

Hi Jason
I like the idea.
But what do you think of still use the same wizard I have in the mockup for
creating the documentation and the when the users are going to read the
documentation they can see it in cards?

I think a first-pass implementation where editors would edit a
gist-fork of a card would be sufficiently easy for most contributors.
Do you feel only an authoring wizard (in addition to a user wizard) is
the only way it can be editable?

Can you reshare your mockup?

Are you still engaged in this process?

6

Yes I am.
I think I got the idea of cards.
This is the mockup: https://www.lucidchart.com/documents/view/491e9c60-532a-7820-a2af-44400a004cb7

7

https://www.lucidchart.com/documents/view/491e9c60-532a-7820-a2af-44400a004cb7

In the mockup there are the two views. Creating and viewing it.
When you click in the bottom Create. A new Windows appears and you select all what type of “Card” you want
You can add as many cards. This is not going to be the Read All page. Just for creating it.

8

https://www.lucidchart.com/documents/view/491e9c60-532a-7820-a2af-44400a004cb7

In the mockup there are the two views. Creating and viewing it.
When you click in the bottom Create. A new Windows appears and you select all what type of “Card” you want
You can add as many cards. This is not going to be the Read All page. Just for creating it.

If you can, try to avoid top-posting as it makes it difficult to pick the conversation back up when monitoring a lot of message traffic.

Each of the mock-ups looks the same to me.

I think what is missing is the idea of what a “Code” card or a “Hardware” card looks like and how you’d go through a typical tutorial. I think the advantage of using “cards” is also that they can be shifted around quickly without a navigation menu, but instead groupings… like you’d shuffle through a recipe box or spread cards out on a table looking for the right one. The Adafruit learning system (Adafruit Learning System) does this, they just don’t have the concepts of interactivity or forking on github. The layouts also look like boxes rather than “BeagleBone-shaped cards”. Hope that link helps.

I’m concerned I may have you at a disadvantage because you don’t have a BeagleBone Black.