doc/getting-started: Fix links, minor cleanup #21472
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crasbe
added
Type: enhancement
Contributor
Author
|
I forgot to push the fixed reference links 👀 |
Contributor
Author
|
@Teufelchen1 I just had a thought: wouldn't it be better to link to the new Guides page instead of linking to GitHub, which can only somewhat render the .mdx file? Also ping @AnnsAnns. |
Member
|
I have nothing against that :D |
Contributor
Author
|
Thanks for looking into this :) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
During our seminar, we discovered some issues with various distributions (especially Fedora and Arch Linux, for the latter I added a commit in #21395).
Also, the Getting Started guide is outdated and said that it is not possible to pass through USB devices, which is not correct (anymore).
Furthermore, #21436 introduced a regression. The link to the WSL guide in the Getting Started page was dead.
All in all, I used the opportunity to clean the Getting Started documentation up a bit, even though it'll be eventually replaced by the Starlight documentation.
Testing procedure
Generate the documentation and see that everything still looks fine.
Issues/PRs references
Fix regression from #21436.