Skip to content

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

Merged

Conversation

krzysztof-cabaj
Copy link
Contributor

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

@github-actions github-actions bot added the Area: doc Area: Documentation label Jun 30, 2025
@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Jun 30, 2025
@crasbe
Copy link
Contributor

crasbe commented Jun 30, 2025

Ping @AnnsAnns :)

@mguetschow
Copy link
Contributor

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).

@AnnsAnns
Copy link
Contributor

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.

Copy link
Contributor

@AnnsAnns AnnsAnns left a 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 😅

@krzysztof-cabaj
Copy link
Contributor Author

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).

Hmmm ... I didn't notice that ... but after first look examples directories in doxygen version looks OK.

@mguetschow
Copy link
Contributor

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.

We just discussed this briefly at the maintainers meeting and came up with the following:

  • deprecate the doxygen version using the @deprecated doxygen tag at the top of the file (let's keep fingers crossed that actually works), with pending for removal after two releases from now (2025.11), deleting all its content and replacing it with a link to the guides site (before deleting make sure there were no diverging changes between the doxygen version and the guides site)
  • add a prominent link to the general guides site on doxygen, either in the top bar, or in the left navigation bar

Would you be willing to help us with this @AnnsAnns ?

@mguetschow
Copy link
Contributor

(this is of course all follow-up of this PR, which looks good to me)

@AnnsAnns
Copy link
Contributor

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.

We just discussed this briefly at the maintainers meeting and came up with the following:

* deprecate the doxygen version using the `@deprecated` doxygen tag at the top of the file (let's keep fingers crossed that actually works), with pending for removal after two releases from now (2025.11), deleting all its content and replacing it with a link to the guides site (before deleting make sure there were no diverging changes between the doxygen version and the guides site)

* add a prominent link to the general guides site on doxygen, either in the top bar, or in the left navigation bar

Would you be willing to help us with this @AnnsAnns ?

Sure sounds good, will help :)

@riot-ci
Copy link

riot-ci commented Jun 30, 2025

Murdock results

✔️ PASSED

39f1933 doc/guides: fix examples directories

Success Failures Total Runtime
1 0 1 01m:36s

Artifacts

@mguetschow mguetschow added this pull request to the merge queue Jun 30, 2025
@mguetschow mguetschow added Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors) and removed Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation Type: cleanup The issue proposes a clean-up / The PR cleans-up parts of the codebase / documentation labels Jun 30, 2025
Merged via the queue into RIOT-OS:master with commit 7d2c9d1 Jun 30, 2025
34 checks passed
@Teufelchen1 Teufelchen1 added this to the Release 2025.07 milestone Jul 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: bug The issue reports a bug / The PR fixes a bug (including spelling errors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants