Improve docs #5668
Merged
Improve docs #5668
Conversation
This file contains 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
- Subsection for installing from source - Add callouts - Mention fix for missing development dependency - Easier code copy-pasting - Mention flatpak as external package
and rename guide to adding module to module structure
RensDofferhoff
approved these changes
Sep 18, 2024
RensDofferhoff
approved these changes
Sep 18, 2024
JorisGoosen
pushed a commit
that referenced
this pull request
Sep 30, 2024
* Improve installation instructions - Subsection for installing from source - Add callouts - Mention fix for missing development dependency - Easier code copy-pasting - Mention flatpak as external package * Improve clarity by moving common errors to its own subsection * Reduce visual clutter * Describe GitHub PAT fix * Add puzzle visualization and rename guide to adding module to module structure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Improved clarity of the docs, for instance:
Context
I am not finished working on the documentation, but I'd like this to be merged now. I made the mistake of working directly on my own branch instead of on my own fork. After merging, I'll create my fork and take it from there. Sorry for the, I hope, minor inconvenience.