Code Monkey home page Code Monkey logo

dev-docs's Introduction

License: CC BY-SA 4.0

Microbit Developer Community Docs

These docs form the content that is rendered into the micro:bit Developer Commmunity site

Using these docs

These docs are made available under a Creative Commons license, to support the micro:bit community. Issues and Pull Requests are welcomed and encouraged. Please review the Foundation community and brand guidelines and the tech.microbit.org homepage for further details about contribution.

Documentation development tools

  • The docs are mostly written in Markdown

Code of Conduct

Trust, partnership, simplicity and passion are our core values we live and breathe in our daily work life and within our projects. Our open-source projects are no exception. We have an active community which spans the globe and we welcome and encourage participation and contributions to our projects by everyone. We work to foster a positive, open, inclusive and supportive environment and trust that our community respects the micro:bit code of conduct. Please see our code of conduct which outlines our expectations for all those that participate in our community and details on how to report any concerns and what would happen should breaches occur.

dev-docs's People

Contributors

bdelaup avatar carlosperate avatar cleoqc avatar devegied avatar dysbulic avatar exponentactivity avatar gadgetoid avatar jaustin avatar kiate avatar leobriand31 avatar markfirmware avatar martinwork avatar medishield avatar merwok avatar microbit-carlos avatar microbit-mark avatar microbit-matt-hillsdon avatar microbit-matt-smith avatar microbit-pauline avatar microbit-robert avatar microbit-rosslowe avatar microbit-sam avatar mike-eason avatar mikini avatar ngammarano avatar padmano avatar rneacy avatar saitoyutaka avatar themarkness avatar tsh-xx avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

dev-docs's Issues

Layout of pages when rendered doesn't reflect filesystem

Our Jekyll/permalink setup leads to illogical looking relative links, for example for a Markdown file in the same directory, we end up with (adjacent file)[../adjacent-file].

This works, but it makes it hard to use !Jekyll to browse the docs. GitHub is !Jekyll and should be a priority as soon as we've got the site up and stable.

(Using full URLs somewhat mitigates this, but finding a more complete solution would be better)

mechanical page

The hardware index page points to ./mechanical.md, which does not exists. Not sure if it's meant to point to /hardware/edgeconnector/, /hardware/edgeconnector_ds/, or something else.

Add default type 'question' to 'get involved' widget

The widget that requests slack access here: http://tech.microbit.org/get-involved/where-to-find/

does not correctly set the ticket type to question. This creates double work at the receiving end, as I can't manage the ticket with a single click, it requires me to edit the properties before resolving the ticket.

Documentation is here:

https://support.freshdesk.com/support/solutions/articles/37690-getting-feedback-from-your-website-with-the-feedback-widget-

And here:

https://support.freshdesk.com/support/solutions/articles/154064-pre-populating-feedback-widget-form

pin map column error

(2) The column labelled dir is described as startup in the list of columns.

microbit.org-ticket: 541

ALL MY PROJECTS DISSAPEARED!

I have used makecode web for a long time I made many projects but now all my projects disappeared and I need to do all again.

Timer/Event block documentation

We've had some queries from users wishing to use the micro:bit to control 4 PWM channels, e.g. for quadcopter control.

The nRF51 datasheet on table 12 states there are 3 TE units, each with 4 channels.

It would be helpful to have some additional tech information in our tech docs stating how each of the timer peripherals are allocated on the micro:bit (in fact, as a wider thing, how about a detailed breakdown of how every nRF51 on board peripheral is mapped to features?) so that it would be easier for people to answer these sorts of questions themselves.

In particular, with full knowledge of how timer TE units are allocated for each Timer, it would be much easier to assess whether going in at the mbed level (or throwing mbed away completely and coding direct to the core) would support various project development ideas.

Broken link to home on Slack page

The 'Home' page link on the 'Request to Join Slack Channel' page does not link to home - it redirects back to the same 'Request to Join Slack Channel' page.

Feedback from electronics engineer

  1. simple intro/overview of the hardware specs, including power requirements and environmental conditions

  2. I was not clear about power via USB and current draw. Are these limits for the onboard stuff or does it include a small(?) provision for external bits? I assume that USB volts is 5V.

  3. I would like to see something about mating cycles of the edge connector and more specific recommendations regarding this and a recommended part(s).

  4. What I think would/could be more useful is if the core processor with code was made available and pre-programmed chips sold perhaps with some carrier to enable it to be plugged in to a breadboard.

pin numbers on PCB

(1) On the Edge Connector Data sheet, there is nothing to say what the pin numbers on the PCB are, so it would help to have the reference to the pins (as is available in the here link on the more info page).

microbit.org-ticket: 541

microbit daplink mbed page 404

This link no longer works: https://www.mbed.com/en/development/hardware/prototyping-production/daplink/daplink-on-kl26z/
Google cache: https://webcache.googleusercontent.com/search?q=cache:cWB53FQwfRAJ:https://www.mbed.com/en/development/hardware/prototyping-production/daplink/daplink-on-kl26z/+&cd=1&hl=en&ct=clnk&gl=uk

The link in the documentation is used here:

There are detailed instructions for how to update 'interface' version of DAPLink [here](https://www.mbed.com/en/development/hardware/prototyping-production/daplink/daplink-on-kl26z/)

I was also linking to this in a list of micro:bit resources, so it'd be great if we could find an alternative or it's new location if it has been moved.

KL26 or KL26Z

We are refering the interface microcontroller as KL26 or KL26Z, we should probably stick to one.

To be honest, I'm not sure which one is the "correct" one. DAPLink refers to the procressor as a KL26Z, but a google search for "KL26Z" gives mostly results about the FRDM-KL26Z development board. NXP refers to the family as the "Kinetis KL26" (although all parts contain the Z in the format MKL26Zxxxyyyy), so "KL26" is likely to be correct one.

Search

There is no search on tech.microbit.org - so how do people find things if they don't know what category heading that information belongs under?

We should explain a little more what slack is

Some people may not know what Slack is, and at the moment that's our main engagement system.

We should also be clear we don't consider slack a replacement for a forum - as that's put some people off. Drawing the line that Slack is equivalent to IRC/for live collaboration and other communications means will come in time might help clear this up.

Remove 'help us automate slack'

Can we remove the text from the get-involved page that says 'help us automate slack' - we don't need any help doing this, it's already pretty slick.

Edge connector data sheet pullups unclear

(5) in the case of the pull? column, it’s not clear whether the external pullups or pulldowns are obligatory or not. Likewise, it’s not clear under what circumstances the m:b ring pins 2 and 3 are up or down - or either.

microbit.org-ticket: 541

Broken image link

Clarification for Windows temporary issue after updating DAPLink firmware

Looks like it might be a known issue for DAPLink (still needs confirmation from mbed team): ARMmbed/DAPLink#286

Basically on Windows, after flashing DAPLink, the first target flash can throw a "File sent out of order by PC. Target might not be programmed correctly" error, but it should work the second time.

If this is confirmed it might be nice to have a note in https://github.com/microbit-foundation/dev-docs/blob/master/software/interface.md
Although it would be even better to have a note in https://www.mbed.com/en/platform/hardware/prototyping-production/daplink/daplink-on-kl26z/

3D file availability mentioned. Link not provided.

On http://tech.microbit.org/hardware/ You state that you have some 3D models of the Micro:bit but don't provide links to them. They would be really handy to have available.

"We have some nice 2D and 3D CAD drawings and models of the micro:bit including all the important dimensions. These models can be used as a basis for generating really nice marketing and project images of the micro:bit, but also as a basis for accurate manufacture of attachments e.g. via 3D printing."

Contributed Fritzing diagram for micro:bit

contributed by: Kok Ho Huen

The attached .fpz file is an active fritzing part for the micro:bit - each of the GPIO pins can be wired to with Fritzing wires.

Ho developed this part in his own time, and has kindly said that we can use it on our tech site:

Microbit.fzpz.zip

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.