Fix board_id formatting in seeed_xiao_esp32s3_sense.md#1745
Fix board_id formatting in seeed_xiao_esp32s3_sense.md#1745Timeline8 wants to merge 3 commits intoadafruit:mainfrom
Conversation
When using Circup, when the version of CP is out of date, the URL to the board's download page on CircuitPython.com displayed by Circup is determined by
```py
if board_id:
url_download = f"https://circuitpython.org/board/{board_id}"
```
(source: https://docs.circuitpython.org/projects/circup/en/stable/_modules/circup.html#Module)
and currently the board_id and URL do not match.
Correct URL for this board is https://circuitpython.org/board/seeed_xiao_esp32s3_sense/ so the board_id in this file needs to be changed
from seeed_xiao_esp32_s3_sense
to seeed_xiao_esp32s3_sense
makermelissa
left a comment
There was a problem hiding this comment.
The board_id should match the board in CircuitPython: https://github.com/adafruit/circuitpython/tree/main/ports/espressif/boards/seeed_xiao_esp32_s3_sense
So, I think the file name is incorrect and should be changed to seeed_xiao_esp32_s3_sense.md
|
Change the file name but leave the ID change as I have it? |
|
No, please leave the id field as it originally was. Otherwise it would be different from the one in circuitpython, which causes duplicate boards to appear. |
|
But the problem is that Circup generates the URL for that board over at circuitpython.org using the board_id. If I leave the ID as is, then it does not fix the problem I am reporting. Currently circup generates an invalid address of where to go to get the latest version of CP for that board. Alternatively someone could change the URL for that board at circuitpython.org but then that may break bookmarks and embedded web page links. |
Changing the filename will change the URL at circuitpython.org and that's fine. |
|
Ah I didn't realize the file name here was directly linked to the URL. I am trying to figure out how to revert the previous change of the board_id but I can not figure out how to revert it. I'll keep poking. |
|
Just change it back in your code, change the filename and then commit and push the changes. |
When using Circup, when the version of CP is out of date, the URL to the board's download page on CircuitPython.com displayed by Circup is determined by
(source: https://docs.circuitpython.org/projects/circup/en/stable/_modules/circup.html#Module)
and currently the board_id and URL do not match.
Correct URL for this board is https://circuitpython.org/board/seeed_xiao_esp32s3_sense/ so the board_id in this file needs to be changed from seeed_xiao_esp32_s3_sense to seeed_xiao_esp32s3_sense