doc/guides: Add Getting Started guide #21436
Conversation
|
As #21404 has been merged this PR is now ready for review (and now actually readable 😄) |
|
@maribu can I get you to review the file |
From all I can remember the install-wsl guide should actually be close to identical with the previous one. So a review will probably not be as annoying as it may seem 😄 |
|
I can confirm that the changes to the WSL guide are just impedance matching for different markdown flavors. It would probably be good to check if the guide is actually still accurate. But the goal of this PR is not updating the WSL guide. So even if the guide would no longer be accurate, I think updating it would be a separate PR. (And we can update the guide after this PR just was well, so I see no reason of delaying this PR for checking the WSL guide.) |
|
Thanks for working on this! Is it already previewed somewhere (automatically?) for a lazy reviewer like me? |
Sadly not, the more I think about this the more this would probably be a really nice feature to have. I initially thought this could be solved using the doxygen preview CI script we have but this might not be the case as starlight is path sensitive and would break with the approach we are taking for the doxygen preview (Just drop all the files into a folder named after the commit) unless we change some config parameters within astro.config.ts within the CI each time. TLDR: Really neat but possibly harder to integrate with the current preview system than I would have initially guessed. (I also quite frankly don't even properly understand Murdock, feels hard to understand from the outside 😅) |
0a50ad6 to
69e303d
Compare
69e303d to
8a0df4b
Compare
doc/guides: remove original windows guide
dd2873a to
d511d60
Compare
Contribution description
This is the initial part of the three part tutorial introduction PR-chain. The goal of this very initial PR is to set the foundation and also adapt the great tutorial that was already hidden within the doc folder (The Windows WSL tutorial) to be more of a general getting started tutorial that can be used by everyone to get familiar with RIOT.
The subsequent PRs will then introduce #21434 C Tutorials and #21435 Rust Tutorials.
Testing procedure
This PR should only touch the guides site and modernize some parts of the already existing guides we had. There are no code changes outside of the guides site, nor testable code.
Issues/PRs references
Depends on #21404Got merged!Parent of #21434
Parent of #21435