docs: improve blink-and-read tutorial with collapsible sections #119
Conversation
SissiFeng
commented
Oct 31, 2024
SissiFeng
commented
- Add key concepts summary from external resources
- Include code templates and examples
- Add interactive checkpoints
- Improve light sensor integration section
- Reduce dependency on external links
- Add key concepts summary from external resources - Include code templates and examples - Add interactive checkpoints - Improve light sensor integration section - Reduce dependency on external links
There was a problem hiding this comment.
Thanks for putting this together. After seeing this, I think I prefer the original version. In general, I'd also like to avoid using the details html (occasionally might make sense). I'd prefer to use built-in features of the sphinx book theme and sphinx-design packages.
I think the intro material can be left (basic pico w setup, etc.). But all the other changes should be cut I think.
| @@ -17,20 +17,64 @@ Learn how to write MicroPython scripts and use a Raspberry Pico W microcontrolle | |||
|
|
|||
| ### Getting Started with the Pico (Optional) | |||
|
|
|||
| Read the [Getting Started with the Pico](https://projects.raspberrypi.org/en/projects/getting-started-with-the-pico) tutorial, some which overlaps with prior content. Note that the onboard led for the Pico W is accessed via `onboard_led = Pin("LED", Pin.OUT)` instead of `onboard_led = Pin(25, Pin.OUT)`, which is for the original Pico. For the "Use digital inputs and outputs", "Control LED brightness with PWM", and "Control an LED with an analogue input" sections, you can still *run* the code without the optional hardware (button, wire-lead LED, resistor, potentiometer, breadboard, M-M jumper leads), though you won't be able to observe the effect. | |||
| The onboard LED is distinct from the RGB NeoPixel LED that you will be using later in the module. | ||
| ``` | ||
| <details> | ||
| <summary>📚 Key Concepts from Getting Started Guide</summary> |
| led = Pin("LED", Pin.OUT) | ||
| ``` | ||
|
|
||
| 2. **Common Pin Functions** |
There was a problem hiding this comment.
Thinking again, I'm not sure these are going to offer a lot of benefit to the target audience. I think the pin mapping of the Pico W and the Maker Pi Pico base would be sufficient.
| </details> | ||
|
|
||
| <details> | ||
| <summary>🔧 Common Setup Issues & Solutions</summary> |
There was a problem hiding this comment.
With the revamp of 1.1 running the demo (something I'd like to have a lot of oversight on), I think this may become unnecessary.
