Update installation guide#1296
Merged
Merged
Conversation
* Fix formatting errors. * Move switching branches to FAQ. * Fix some links.
Collaborator
|
Weird that this did bit came up during review. Sorry for overlooking. |
spjuhel
approved these changes
Jun 16, 2026
spjuhel
left a comment
spjuhel
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for the cleanup of urls!
This is good to merge for me 👍
Member
Author
|
Thanks for reviewing. All good! ✌️ |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Changes proposed in this PR:
During #977, a section in Markdown was added to the installation guide (an RST file), whose rendering is obviously completely broken. I fixed that and moved the section to the FAQ, as its instructions are a bit unclear at the position it was placed before. It fits nicely into the FAQ because updating the environment is also explained there.
Also, obviously, please always check that changes to the docs are rendered correctly. This is a bit annoying.
Before:
After:
PR Author Checklist
develop)PR Reviewer Checklist