README: simplify the README to refer to the documentation #1380
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
15f10ef to
e419103
Compare
A lot of information was moved to the documentation so we ended up with duplicate of stuff between the doc website and the README. This should simplify the situation with a smaller README redirecting to the more complete documentation. Signed-off-by: Mahe Tardy <mahe.tardy@gmail.com>
e419103 to
b72a6dc
Compare
|
I'm not sure of this README, I think there's maybe too much hyperlink. If you have suggestions that would be helpful. Let me ping @xmulligan as well maybe he has an opinion on READMEs? :) |
kkourt
approved these changes
Aug 30, 2023
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.
A lot of information was moved to the documentation so we ended up with duplicate of stuff between the doc website and the README. This should simplify the situation with a smaller README redirecting to the more complete documentation.
Preview the README