bbcmicrobit / micropython

Port of MicroPython for the BBC micro:bit
https://microbit-micropython.readthedocs.io
Other
606 stars 283 forks source link

Create setup/on-boarding documentation #124

Open ntoll opened 8 years ago

ntoll commented 8 years ago

Must take into account the following platforms:

Can include screen-shots, links and videos if required.

MUST HAVE

Nice to have

willingc commented 8 years ago

@ntoll I put a skeleton doc structure for this together. If we like it and merge it, others can help flesh out the content. Will open a PR.

Here's a screenshot of the sidebar navigation and one doc.

screen shot 2015-12-01 at 9 00 35 am
ntoll commented 8 years ago

@willingc great minds think alike, or fools seldom differ. I was just about to start doing something about this, this evening only to find you're several steps ahead of me! Also, I've just replied to an email from Naomi where she's having similar thoughts.

Three heads are better than one! :-)

ntoll commented 8 years ago

Also, I've been working on some sort of Windows solution for teachers based on a Chromium App. The workshops have demonstrated it's quite a painful journey and I think this could be one way to help given the prevalence of both Chrome (the browser) and Chromebooks in classrooms. :-/

willingc commented 8 years ago

No problem. I find good docs help with making things more pleasant to use.

I just got a Windows 10 desktop so I will be able play around with it. Please encourage folks to iterate on the docs :D

ntoll commented 8 years ago

@willingc you have an account on RtD? I can add you as an admin!

willingc commented 8 years ago

@ntoll Yep, I do (same as my github username). Not sure why the docs didn't autodeploy without hitting build in RTD. Probably don't have the hook set up in the RTD settings.

willingc commented 8 years ago

GIFs are a good way to give people an overview of steps in the process. Most folks can only retain 3 or 4 steps at a time.

ntoll commented 8 years ago

@willingc OK... you're added as an admin.

willingc commented 8 years ago

@ntoll Thanks.