Docs: Rework Readme#348
Draft
ByteOtter wants to merge 1 commit into
Draft
Conversation
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
yeoldegrove
requested changes
May 20, 2026
Comment on lines
33
to
73
| @@ -72,7 +72,8 @@ for feature in feature_list: | |||
| print(feature) | |||
| ``` | |||
Contributor
There was a problem hiding this comment.
Let's remove the "installation" section and directly link the docs that explain it.
Comment on lines
+75
to
77
| For more examples and for all CLI tools, see the **Command-Line Interface** and | ||
| **API Reference** sections in the docs: | ||
| [https://gardenlinux.github.io/python-gardenlinux-lib/](https://gardenlinux.github.io/python-gardenlinux-lib/) |
Contributor
There was a problem hiding this comment.
Properly link to docs.
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.
What this PR does / why we need it:
Restructure README.
Which issue(s) this PR fixes:
Fixes gardenlinux/gardenlinux#4797