Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Branch with the V2 documentation #743

Closed
wants to merge 11 commits into from
Closed

docs: Branch with the V2 documentation #743

wants to merge 11 commits into from

Conversation

microbit-carlos
Copy link
Collaborator

This draft PR shows the doc updates for micro:bit V2, which is deployed to ReadTheDocs as the default entry point, which expands to: https://microbit-micropython.readthedocs.io/en/v2-docs/

Many of the changes to the v2-docs branch that were not specific to V2 have been backported to the V1 docs, and this branch will be constantly rebased.

Having this as opened as PR makes GitHub track the changes between rebases (it adds a timeline entry linking to the old tree), so it can be used for traceability in case some merge/rebase goes wrong.

microbit-mark and others added 2 commits April 28, 2022 18:21
@microbit-mark @microbit-carlos
docs: Update the docs to include the V2 API (bbcmicrobit#692)
cd5a13e 
* Add microphone API

* include V2 on index

* update music and V2 pins

* update speech

* update audio

* update i2c

* add description to built-in sounds

* format sounds

* format pins

* format pins

* spelling

* Update docs/audio.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/audio.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/i2c.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* changes based on initial feedback

* update return pin

* sound is in microbit module

* Update docs/audio.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* more feedback updates

* spacing

* Update docs/audio.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* does this comment work?

* Revert "does this comment work?"

This reverts commit 4846113.

* update audio

* update audio

* add Python Editor

* add references to sound

* update mic image

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* multiple fixes

* use Param in docs

* update SouneEvent

* update microphone module

* update param

* update image list

* update parameters

* remove note

* update param

* add line break

* add mic and make clases a-z

* format parameters

* Update docs/microbit_micropython_api.rst

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* more updates

* tidy up

* move SoundEvent

* Revert "move SoundEvent"

This reverts commit 8f52c97.

* move soundEvent

* update image list

* remove param reference

* more feedback updates

* move audio to modules

* Update docs/music.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microphone.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microbit_micropython_api.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/microphone.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/music.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/audio.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* more updates

Co-authored-by: Carlos Pereira Atencio <[email protected]>
@microbit-mark @microbit-carlos
Docs: update for V2 neopixel module (bbcmicrobit#694)
309a585 
* Docs: update for RGBW neopixel

* Docs: RGBW neopixels

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* change to bpp

* change to bpp

* add image attribution

* Update docs/neopixel.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Add V2 methods

* Docs: Update neopixel

Co-authored-by: Carlos Pereira Atencio <[email protected]>
microbit-mark and others added 9 commits April 29, 2022 10:22
@microbit-mark @microbit-carlos
Docs: Speaker update and play() pin arguments (bbcmicrobit#695)
933c34e 
* speaker pin changes

* Docs: update speaker pin info

* Add speaker page

* grammar

* Link to speaker page

* add speaker to navigation

* add speaker example

* Update docs/speaker.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/speaker.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Update docs/music.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>

* Docs: Update speaker pin

* remove build

* gitignore _build directory

* update music

* Update docs/music.rst

* Update docs/speech.rst

* Update docs/speech.rst

* Update docs/speech.rst

* Update docs/music.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>
@microbit-carlos
V2 docs: Remove is_on() from speaker. (bbcmicrobit#696)
00b59d3
@microbit-mark @microbit-carlos
V2 docs: Add pin set_touch_mode() (bbcmicrobit#701)
c024951 
* V2 docs: add set_touch_mode()

* V2 docs: add set_touch_mode() to micropython API doc
@microbit-sam @microbit-carlos
docs: Update Memory layout, Partial Flashing, Building for V2, BLE (b…
a38b3e2 
…bcmicrobit#705)

* Add layout table and partial flashing

* deprecated appending script

* add build info for v2

* Add section on BLE DFU for V2

* Carlos' feedback

* fix filesystem link

* fixup! fix filesystem link

* fixup! fixup! fix filesystem link

* formatting

* formatting

* fix filesystem link

* Update docs/devguide/hexformat.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>
@microbit-mark @microbit-carlos
docs: Include V2 features in tutorials (bbcmicrobit#709)
0dcd7a6 
* docs: update-tutorials for V2

* docs: update images

* remove pin functions reference link

* reduce size of image

* Update docs/pin.rst

* Update docs/pin.rst

* Update docs/tutorials/io.rst

Co-authored-by: Carlos Pereira Atencio <[email protected]>
@microbit-mark @microbit-carlos
docs: dev guide updates (bbcmicrobit#711)
e11a2c5 
Completes and merges build and flash pages.
Adds V2 info.
Removes outdated FAQ page.
Adds WebUSB info to REPL page.

Rebase update: Keeps and updates the flashing paragraph in
flashfirmware page.
@microbit-mark @microbit-carlos
docs: Indicate pin_speaker is only for PWM (bbcmicrobit#715)
9b690a7
@microbit-matt-hillsdon @microbit-carlos
docs: Fix typo in neopixel, mumber -> number (bbcmicrobit#727)
790f387
@microbit-carlos
docs: Add V2 microbit.set_volume() info. (bbcmicrobit#742)
45c3f4d
@microbit-carlos microbit-carlos deleted the v2-docs branch April 29, 2022 09:39
@microbit-carlos microbit-carlos mentioned this pull request Apr 29, 2022
Draft
@microbit-carlos
Copy link
Collaborator Author

microbit-carlos commented Apr 29, 2022 •
edited
Loading

As I had the same v2-docs branch in my fork as well I must have accidentally opened this PR pointing to my fork instead of the branch on this repo, so I've opened #746 with the right branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@microbit-carlos @microbit-mark @microbit-sam @microbit-matt-hillsdon