doc: Deprecate doxygen guides and sync changes#21573
Conversation
crasbe
added
Type: cleanup
|
The change creates a reference error, because the |
Already fixed 😉 |
| For zsh users a RIOT-aware completion is provided in | ||
| `dist/tools/zsh-completion`. Refer to the `README.md` in there for more details | ||
| and installation instructions. | ||
| @deprecated See [Advanced Build System Tricks](https://guide.riot-os.org/build-system/advanced_build_system_tricks/) on the RIOT Guide Site for the latest information. This page will be removed in a future release. |
There was a problem hiding this comment.
Thanks for doing this!
| @deprecated See [Advanced Build System Tricks](https://guide.riot-os.org/build-system/advanced_build_system_tricks/) on the RIOT Guide Site for the latest information. This page will be removed in a future release. | |
| @deprecated See [Advanced Build System Tricks](https://guide.riot-os.org/build-system/advanced_build_system_tricks/) on the RIOT Guide Site for the latest information. This page will be removed after release 2025.11. |
and similar on all the other pages
|
I made a few more changes to the getting started and mainpage of doxygen, and I moved the architecture specific dependencies into the guide itself (which is probably something I should have done in the first place) |
doc/doxygen/src/mainpage.md
Outdated
| [mastodon-link]: https://fosstodon.org/@RIOT_OS | ||
|
|
||
| The quickest start {#the-quickest-start} | ||
| Getting Started {#getting-started} |
There was a problem hiding this comment.
doxygen complains about #getting-started being defined more than once (see above)
| ## Architecture Specific Requirements | ||
|
|
||
| :::caution[Don't get lost] |
There was a problem hiding this comment.
Would it make sense to move this to a subpage / another guide?
There was a problem hiding this comment.
I thought about it but it also feels out of place on its own, in the end this felt like the best location for it.
|
Did I miss anything in the review that still needs to be done? |
crasbe
left a comment
crasbe
left a comment
There was a problem hiding this comment.
I still have to look at the generated documentation.
crasbe
added
the
Process: deprecation
crasbe
left a comment
crasbe
left a comment
There was a problem hiding this comment.
Another thing I just noticed: the two images are swapped:
Or rather: on a Linux system that is not WSL, you will not see "Installing VS Code Server" output, so that screenshot is a bit redundant IMO.
Not sure if you added that or if it was present before?
|
@AnnsAnns I know you are busy with exams, but any chance on getting this in today or tomorrow? Would be nice to have it in the upcoming release. |
|
I will try to get this done tonight no worries |
fix: add note when sections will be removed
AnnsAnns
force-pushed
the
doxygen_deprecation
branch
from
7f5528c to
3eda07e
Compare
|
This should cover everything, if anything else needs to be done let me know and I will try to squash (hehe) it in tomorrow if I have time |
|
Ty 😄 |
|
You guys rock! |
6 participants
Contribution description
This syncs any changes that were only added to doxygen and also deprecates all guides that are currently in both starlight and doxygen with one exception, I did not deprecate the structure, while technically in both doxygen and starlight, considering that the structure guide is also a sort-of guide to our API Documentation structure and how to navigate it.
There were 0 changes outside of that, this PR neither adds nor removes any content, it simply redirects/updates the existing guides to be in-sync with each other and deprecate anything that has two sources of truth.
Testing procedure
Build
make doc-starlightandmake docIssues/PRs references