tessel / t2-start

Tessel 2 start docs! Open for contributions.
http://tessel.io/start
35 stars 31 forks source link

De-emphasize modules #144

Open Frijol opened 8 years ago

Frijol commented 8 years ago

Discussed today with @tcr and @HipsterBrown.

Problems identified:

Ideas:

cc @rwaldron @reconbot

Frijol commented 8 years ago

@tcr made this exploratory version of t2-docs for the accelerometer module https://github.com/tessel/t2-docs/blob/tcr-modules/Modules/Accelerometer.md

Frijol commented 8 years ago

Put some more thought into this, and I'm now in favor of keeping the module pages in t2-start. The experiences we have there are explicitly first-run. Meanwhile, there do exist separate docs for the modules already, just on their specific module pages. I think it's appropriate for the module first-runs to link out to those, as they already do.

I think the documentation issue regarding modules is better solved by examining how we can best link module documentation and examples from tessel.io/docs through from the Readmes on the repos of those modules. This, while maintaining simple gitbook format, but also keeping the readmes where they are because that's good documentation for npm.

^ none of which solves the central point of this issue :)