docs: Add overhauled Getting Started guide #400
Merged
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
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## master #400 +/- ##
==========================================
- Coverage 97.52% 97.40% -0.12%
==========================================
Files 31 31
Lines 2581 2581
==========================================
- Hits 2517 2514 -3
- Misses 64 67 +3 ☔ View full report in Codecov by Sentry. |
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.
After introducing the reworked contributing guide, further parts of the documentation could be improved as well. Add a new overhauled Getting Started guide as a dedicated section into the documentation. This replaces the previous "Building" and "Integration" sections in the
READMEand contains more detailed instructions in a cleaner layout.Furthermore, the links in the contributing guide are also updated to point to this new guide.