Skip to content

Fix board_id formatting in seeed_xiao_esp32s3_sense.md#1745

Open
Timeline8 wants to merge 3 commits intoadafruit:mainfrom
Timeline8:patch-1
Open

Fix board_id formatting in seeed_xiao_esp32s3_sense.md#1745
Timeline8 wants to merge 3 commits intoadafruit:mainfrom
Timeline8:patch-1

Conversation

@Timeline8
Copy link
Contributor

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

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

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
Copy link
Collaborator

@makermelissa makermelissa left a comment

Choose a reason for hiding this comment

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

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

@Timeline8
Copy link
Contributor Author

Change the file name but leave the ID change as I have it?

@makermelissa
Copy link
Collaborator

makermelissa commented Mar 19, 2026

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.

@Timeline8
Copy link
Contributor Author

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.

@makermelissa
Copy link
Collaborator

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.

@Timeline8
Copy link
Contributor Author

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.

@makermelissa
Copy link
Collaborator

Just change it back in your code, change the filename and then commit and push the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants