Skip to content

Conversation

@XDanielPaul
Copy link
Member

@XDanielPaul XDanielPaul commented Oct 6, 2025

Description

This MR introduces a workshop for ESP Community event with the theme MicroPython Jupyter in the Browser with ESP32-C3

Link to assignments

https://xdanielpaul.github.io/jupyter-lite-micropython/lab/index.html

Related

@XDanielPaul XDanielPaul self-assigned this Oct 6, 2025
@pedrominatel pedrominatel requested a review from f-hollow October 6, 2025 17:34
@pedrominatel pedrominatel added the needs review Needs someone to be assigned to review label Oct 6, 2025
@pedrominatel pedrominatel requested a review from FBEZ October 7, 2025 08:08
- In the ESP Control Panel, click `Disconnect device`, then reopen the notebook and connect again.

## Feedback
If you have feedback for this workshop, please feel free to contact me at [[email protected]](mailto:[email protected]) 🚀
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not share your email here. You can do it during the workshop, only for the participants.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed, thank you for suggestion!

@FBEZ
Copy link
Collaborator

FBEZ commented Oct 7, 2025

Hi @XDanielPaul , thank you for the interesting workshop! I'll proceed with the review today.

In the meanwhile, please split this single page workshop. Consider splitting it into:

  1. An introductory page (the _index.md at the workshop root folder)
  2. A page for the setup ( index.md in a separate setup folder)
  3. A page for each single assignment (index.md each on its assignment_x folder)

You can check the structure of the other workshops:

@XDanielPaul
Copy link
Member Author

Hi @XDanielPaul , thank you for the interesting workshop! I'll proceed with the review today.

In the meanwhile, please split this single page workshop. Consider splitting it into:

1. An introductory page (the `_index.md` at the workshop root folder)

2. A page for the setup ( `index.md` in a separate `setup` folder)

3. A page for each single assignment (`index.md` each on its `assignment_x` folder)

You can check the structure of the other workshops:

* [ESP-IDF with ESP32-C6](https://github.com/espressif/developer-portal/tree/main/content/workshops/esp-idf-with-esp32-c6)

* [ESP-IDF advanced workshop](https://github.com/espressif/developer-portal/tree/main/content/workshops/esp-idf-advanced)

@FBEZ

Thank you for taking a look! I've updated the workshop according to your suggestions apart from renaming the introductory page from index.md to _index.md as it has removed the header (Author, summary, etc.) for some reason.. If you have any idea why, could you explain?

Copy link
Collaborator

@FBEZ FBEZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few suggestions.

Two main themes:

  1. I would focus on the ESP32-C3-DevKit-RUST-2 board, giving all the commands for this board (instead of generic ESP32). I think it makes things more clear. You can always say that the procedure can be easily adapted to any ESP32 family SoC
  2. Avoid repeating the workshop title on each page.
  3. I feel there are some parts a bit too terse and some additional text may help.

You can find everything in the comments.

Copy link
Collaborator

@FBEZ FBEZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few suggestions.

Two main themes:

  1. I would focus on the ESP32-C3-DevKit-RUST-2 board, giving all the commands for this board (instead of generic ESP32). I think it makes things more clear. You can always say that the procedure can be easily adapted to any ESP32 family SoC
  2. Avoid repeating the workshop title on each page.
  3. I feel there are some parts a bit too terse and some additional text may help.

You can find everything in the comments.

@pedrominatel
Copy link
Member

@f-hollow, can you please take a look?

@XDanielPaul
Copy link
Member Author

@FBEZ Thank you for a thorough review! I addressed the changes and pushed them yesterday. I left one question to your comment could you please take a look?

Copy link
Collaborator

@f-hollow f-hollow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@XDanielPaul Thank you for your contribution.

I left a few comments and suggestions. Please also go over the non-implemented comments from Francesco.

Sorry again for some inconvenience with our workshop formatting. We will fix it soon!

@XDanielPaul XDanielPaul force-pushed the main branch 4 times, most recently from 4f4c463 to f0262da Compare October 13, 2025 09:01
### Flashing MicroPython Firmware

1. Connect your ESP32-C3-DevKit-RUST-2 development board to your computer via USB cable
2. Open your Chromium-based browser and navigate to the [website](https://xdanielpaul.github.io/jupyter-lite-micropython/lab/index.html)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can host is somewhere on Espressif servers (or on Espressif's GitHub)?

Copy link
Member Author

@XDanielPaul XDanielPaul Oct 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. I would also like to update the MQTT Broker in Assignment 4 to use ours, do we have something like that publicly available or should I make a deployment for one?

@XDanielPaul
Copy link
Member Author

@f-hollow @FBEZ

Thank you both for the thorough reviews, I've addressed your changes, hopefully I did not miss anything 🚀

I have one question though: Could not figure out what series_order means and whether I've set it up correctly everywhere. Could you please explain?

@f-hollow
Copy link
Collaborator

@f-hollow @FBEZ

Thank you both for the thorough reviews, I've addressed your changes, hopefully I did not miss anything 🚀

I have one question though: Could not figure out what series_order means and whether I've set it up correctly everywhere. Could you please explain?

Our Hugo theme has a brief description of the series parameters. You need to pick a unique identifier for the series and assign consecutive numbers to each article in the series. The main page _index.md should not have these parameters in the YAML frontmatter. Your Introduction and Setup will be series_order: 1 and so on.

Comment on lines 44 to 45
- On Linux or MacOS run command `mosquitto_sub -h test.mosquitto.org -t "esp32/orientation"` in your terminal to subscribe to the topic
- On Windows you will need to add mosquitto to your PATH environment variable or navigate to the path where the executable is located (usually `C:\Program Files\mosquitto\`) and run `mosquitto_sub.exe -h test.mosquitto.org -t "esp32/orientation"`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- On Linux or MacOS run command `mosquitto_sub -h test.mosquitto.org -t "esp32/orientation"` in your terminal to subscribe to the topic
- On Windows you will need to add mosquitto to your PATH environment variable or navigate to the path where the executable is located (usually `C:\Program Files\mosquitto\`) and run `mosquitto_sub.exe -h test.mosquitto.org -t "esp32/orientation"`
- On **Linux** or **MacOS**, run command `mosquitto_sub -h test.mosquitto.org -t "esp32/orientation"` in your terminal to subscribe to the topic
- On **Windows**, you will need to add mosquitto to your `PATH` environment variable or navigate to the path where the executable is located (usually `C:\Program Files\mosquitto\`) and run `mosquitto_sub.exe -h test.mosquitto.org -t "esp32/orientation"`

@f-hollow
Copy link
Collaborator

@XDanielPaul Thank you for incorporating the feedback. I left a couple of suggestions regarding my previous comments, one regarding article heading levels (that became obvious once you enabled TOCs), and only one new comment regarding the URL slug (sorry , I didn't notice it before, and it is quite important).

Once you fix these, I am ready to approve your PR.

@FBEZ
Copy link
Collaborator

FBEZ commented Oct 15, 2025

@XDanielPaul well done, good luck with your workshop!
And thank you @f-hollow for helping with review .

@XDanielPaul
Copy link
Member Author

@FBEZ @f-hollow

Thank you so much for your reviews and suggestions - all of them should be applied. I apologize, I forgot to push the changes yesterday

@pedrominatel pedrominatel merged commit 9886e89 into espressif:main Oct 16, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs review Needs someone to be assigned to review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants