Restructure Readme #4362
Merged
Restructure Readme #4362
Conversation
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
harshil21
reviewed
Jul 9, 2024
Co-authored-by: Harshil <[email protected]>
# Conflicts: # README.rst
Poolitzer
requested changes
Jul 9, 2024
|
Also expanding on my idea for the readme (https://t.me/c/1494805131/14589), I'd like to add a "Features" section. Here is one generated by an LLM:
|
|
@harshil21 Personally not a fan of emojis, I prefer a bullet point list. I don't have anything against this summarising in general though. |
|
I'm with pool on the emojis here 😅 But I added a section and also included corresponding links :) |
harshil21
approved these changes
Jul 10, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Restructures the readme a bit to more prominently point to our documentation & wiki. As a follow-up of this PR, I'll also adjust rules-bot to offer a taghint that points to the
working with ptbsection. That way we'll have a better starting point for newbies