wiki docs about micropython HOT 3 CLOSED

Thanks Mark! How do you imagine the wiki being used? I want to put tutorials and documentation on the micropython.org website. Here on github we have the code and the bug tracking system.

Maybe on the github wiki we can explain the core implementation of the code and how it works. And also the different variants (unix, stm, etc) and what work is needed.

from micropython.

Hi,

the github wiki system relies on gollum a simple but yet powerful wiki
system based on git.
It can be used with a set of different markup languages including org-mode
(for the emacs friends among us ;) ).
More important, since it relies on git, you can pull it in the same way
like the source code and work offline on it.
It could become the companion of the source code for devs keeping all kind
of notes, infos, and help in a single repro.
Devs could easily pull both wiki and code and work offlline on it until
they finally pushing it back.
Not sure how flexible the wiki is in terms of branches and forks but maybe
that is not such a big issue for a wiki.

Thus, I would vote to use the github wiki as a pure dev wiki. Adding all
kind of stuff which couldn't be discussed via the bugtracker.
E.g. internal structures, internal implementations, links for further
reading, porting infos, roadmaps, contact details, explanations for certain
design decisions, coding style rules and stuff which comes handy during
coding (offline), etc.

Just my two cents

Torsten

On 30 December 2013 00:28, Damien George [email protected] wrote:

Thanks Mark! How do you imagine the wiki being used? I want to put
tutorials and documentation on the micropython.org website. Here on
github we have the code and the bug tracking system.

Maybe on the github wiki we can explain the core implementation of the
code and how it works. And also the different variants (unix, stm, etc) and
what work is needed.

—
Reply to this email directly or view it on GitHubhttps://github.com/dpgeorge/issues/6#issuecomment-31328175
.

from micropython.

It sounds like we should pitch it at dev support and put everything else on the main site.
So discussions, collations of information about the various topics and problems that need to be solved.

It can also hold the recommended approaches.
e.g. for making a new port or adding a c lib or...

[later]..Done.

from micropython.