Skip to content

wiki docs #6

Closed
Closed

Description

@Neon22

I've expanded the wiki stubs crudely. Damien do you want any of this info here ?
Specifically I am thinking:

  • only short overview.
  • Concentration on the pyb module and/or other aspects like that ?
  • how to handle different architectures and chip variants.
    e.g. if we did the '407' we might add camera capabilities. For themonster 386 based SOC I pointed to the other day - well its almost a completely diff codebase.

Activity

  1. dpgeorge commented on Dec 29, 2013

    @dpgeorge
    Member

    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.

  2. torwag commented on Dec 30, 2013

    @torwag
    Contributor

    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
    .

  3. Neon22 commented on Dec 30, 2013

    @Neon22
    ContributorAuthor

    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.

  4. added a commit that references this issue on Oct 16, 2016
    0a10d17
  5. added a commit that references this issue on Jan 22, 2017
  6. added a commit that references this issue on Sep 24, 2018
  7. added a commit that references this issue on Dec 18, 2019
  8. added a commit that references this issue on Jun 9, 2020
  9. added a commit that references this issue on Aug 20, 2020
  10. added a commit that references this issue on Feb 14, 2021
  11. added a commit that references this issue on Feb 22, 2021
  12. 3 remaining items

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    rfcRequest for Comment

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions