diff --git a/docs/about.md b/docs/about.md index 99839f62..abde497c 100644 --- a/docs/about.md +++ b/docs/about.md @@ -23,6 +23,8 @@ input.onButtonPressed(Button.B, () => { ``` # About +### @description A Blocks / Javascript code editor for the micro:bit, a pocket-size computer with 5x5 display, sensors and Bluetooth. + The [BBC micro:bit](https://www.microbit.co.uk) is a [pocket-size computer](/device) with a 5x5 display of 25 LEDs, Bluetooth and sensors that can be programmed by anyone. The BBC micro:bit was made possible by many [partners](https://www.microbit.co.uk/partners). diff --git a/docs/blocks.md b/docs/blocks.md index 73ac91c4..9d291c18 100644 --- a/docs/blocks.md +++ b/docs/blocks.md @@ -1,5 +1,7 @@ # Blocks language +### @description Langugage constructs for the Block editor. + ```namespaces for (let i = 0;i<5;++i) {} if (true){} diff --git a/docs/docs.md b/docs/docs.md index c3315da2..0b1a1b50 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -1,5 +1,7 @@ # Documentation +### @description Links to the documentation, reference and projects. + ### Things to do * **[Getting Started](/getting-started)** diff --git a/docs/faq.md b/docs/faq.md index d8b7aa0d..758bf860 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -1,5 +1,7 @@ # Frequently Asked Questions +### @description Frequently asked questions and answers from our users. + ### Where can I get a BBC micro:bit? More information at [http://uk.farnell.com/bbc-microbit](http://uk.farnell.com/bbc-microbit). diff --git a/docs/getting-started.md b/docs/getting-started.md index dab6bddf..6d802209 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,5 +1,7 @@ # Getting started +### @description An activity for beginners to get started with the micro:bit + ## ~avatar Here are some challenges for you. Arrange the blocks in the editor diff --git a/docs/javascript.md b/docs/javascript.md index 25c0ff5c..3a207dc4 100644 --- a/docs/javascript.md +++ b/docs/javascript.md @@ -1,4 +1,4 @@ -# JavaScript and TypeScript +# JavaScript Visit the cards below to starting programming JavaScript and TypeScript with the micro:bit: diff --git a/docs/lessons.md b/docs/lessons.md index c63837e4..8c26b467 100644 --- a/docs/lessons.md +++ b/docs/lessons.md @@ -1,5 +1,7 @@ # Lessons +### @description Lessons to teach computer science and coding. + ### @short Lessons ### ~column diff --git a/docs/open-source.md b/docs/open-source.md index e5872f3b..acfdc086 100644 --- a/docs/open-source.md +++ b/docs/open-source.md @@ -2,7 +2,7 @@ The editor is open source on GitHub under the MIT license. Contributions are welcome, please check our GitHub repos. -### Source Code +## Source Code * [microsoft/pxt-microbit](https://github.com/Microsoft/pxt-microbit), PXT target for BBC micro:bit, also includes the documentation. * [microbit/pxt](https://github.com/Microsoft/pxt), programming experience toolkit (PXT) @@ -12,3 +12,8 @@ The editor is open source on GitHub under the MIT license. Contributions are wel The [C++ micro:bit runtime](http://lancaster-university.github.io/microbit-docs/), created at [Lancaster University](http://www.lancaster.ac.uk/), provides access to the hardware functions of the micro:bit, as well as a set of helper functions (such as displaying a number/image/string on the LED screen). + +## Packages + +* [microsoft/pxt-neopixel](https://github.com/microsoft/pxt-neopixel), package for neopixel strips +* [microsoft/pxt-max6675](https://github.com/microsoft/pxt-max6675), package for Temperature Probe (MAX6675) \ No newline at end of file diff --git a/docs/packages.md b/docs/packages.md index 89753884..37d51d08 100644 --- a/docs/packages.md +++ b/docs/packages.md @@ -1,4 +1,4 @@ -# Extensions +# Packages You can publish libraries (also known as packages or extensions) that users can then add to their scripts. These typically @@ -10,7 +10,7 @@ to a microbit. * [Sample C++ extension](https://github.com/Microsoft/pxt-microbit-cppsample) * [Sample TypeScript extension](https://github.com/Microsoft/pxt-microbit/tree/master/libs/i2c-fram) -## Finding libraries +## Finding packages From the editor, the user clicks on **More** then **Add Package** and searches for the package. @@ -18,11 +18,11 @@ To see the list of packages, click on **More** then **Show Files** to see the pr To remove a package, click on the garbage button in the file list next to the package. -## Publishing libraries +## Publishing packages Packages can be published from the pxt command line. We are still sorting out the details. -## Localizing libraries +## Localizing packages It is possible to package localization strings for the **jsDoc** description associated to the API in the package. diff --git a/docs/reference.md b/docs/reference.md index e5307352..ef289ef6 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -1,5 +1,7 @@ # Reference +### @description List of API categories available in the editors + ```namespaces basic.showNumber(0); input.onButtonPressed(Button.A, () => { diff --git a/docs/release-notes.md b/docs/release-notes.md index caa12c79..45b74f07 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -1,5 +1,7 @@ # Release notes +### @description Editor release notes + ```sim basic.forever(() => { basic.showString("RELEASE NOTES"); }); ``` diff --git a/docs/support.md b/docs/support.md index 306f0938..f308d647 100644 --- a/docs/support.md +++ b/docs/support.md @@ -1,3 +1,5 @@ # Support -Please use the [GitHub issue tracker](https://github.com/microsoft/pxt-microbit) to report bugs. \ No newline at end of file +Send us your feedback and ideas on our [User Voice Forum](https://touchdevelop.uservoice.com/forums/402381-code-the-micro-bit/). + +You can also use our [GitHub issue tracker](https://github.com/microsoft/pxt-microbit) to report bugs. \ No newline at end of file diff --git a/docs/uploader.md b/docs/uploader.md index 65be4005..a16595dc 100644 --- a/docs/uploader.md +++ b/docs/uploader.md @@ -1,5 +1,7 @@ # Uploader +### @description A Windows application that automatically deploys .hex files to connected micro:bit boards + ### ~avatar avatar The Uploader **automatically** deploys .hex files to all micro:bits connected to your computer.