-
Notifications
You must be signed in to change notification settings - Fork 2.1k
doc/guides: fix examples directories #21568
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
doc/guides: fix examples directories #21568
Conversation
Ping @AnnsAnns :) |
Uuuh, this made me stumble upon the fact that some guides are now twice in the source tree - that's really not optimal (see e.g. https://github.com/RIOT-OS/RIOT/blob/94029df898052d6343a0f195ccf88ed1f9ab9839/doc/doxygen/src/build-in-docker.md and https://github.com/RIOT-OS/RIOT/blob/master/doc/guides/build-system/build-in-docker.md). I think we should remove the doxygen version (but make sure we prominently link to the guides from doxygen first). |
I think the idea was to switch gracefully but that was also a few months ago by now and Id call the guide site production ready by now. There was never any official decision (that I know of) whether or not to transition all old guides, which is why we only had a select amount of guides to showcase the possibilities / how the guide site would look. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either way nice catch, I have no complaints 😅
Hmmm ... I didn't notice that ... but after first look examples directories in doxygen version looks OK. |
We just discussed this briefly at the maintainers meeting and came up with the following:
Would you be willing to help us with this @AnnsAnns ? |
(this is of course all follow-up of this PR, which looks good to me) |
Sure sounds good, will help :) |
Contribution description
This PR fix some examples directories names (restructured by PR #21135) in the starlight guides.
Testing procedure
Check if everything in guides is OK -
make doc-starlight
and connect to the dev server http:localhost:4321.Issues/PRs references
PR #21135