-
Notifications
You must be signed in to change notification settings - Fork 2k
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.
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
examples: restructure examples folder #21135
base: master
Are you sure you want to change the base?
Conversation
examples: Fix incorrect category heading examples: shorten coap folder name
I'm gonna rephrase some of my own comments from Matrix over here: |
Could we wait until after the hard freeze, I would expect that the paths would need to be updated in the release specs as well (haven't looked into it though). |
This pulls in the changes of [144]. [144]: RIOT-OS/rust-riot-wrappers#144
…ns/RIOT into restructureExamplesFolder
Contribution description
After #20957 we added a proper structure to the examples folder. This wasn't yet reflected in the actual folder structure within the examples folder. After positive feedback in the Matrix channel I have opened this PR in hopes of adjusting that.
This makes it far easier for newcomers to find what they are looking for and also draws more attention onto the examples folders README which explains the examples in greater detail.
To make it a bit easier to properly view the adjusted structure I'd personally recommend directly looking at the checked out branch at https://github.com/AnnsAnns/RIOT/tree/restructureExamplesFolder/examples
Testing procedure
There are no required verification steps as this doesn't modify any code aside from the
RIOT_BASE
variable within each examples Makefile, I did however have to adjust two CI tests to properly deal with the new examples structure. One of them being a specific examples README check, the other one relying on a fixed hello-world examples path.