Docs: Enhance README with collapsible sections and summaries #5
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
- Added details and summaries for various sections in README. - Provides faster way to get to important information - Sets up structure for easier updates to key sections - Allows maintainers to add more details to environment setup for easier replication.
Author
|
Feel free to disregard if you'd like to keep the current structure, but there are smells to codebases now that don't "care" about code quality. It usually starts with seeing if you're docs have a ton of emojis in it. Something to easily prevent by updating the instructions for your ai cli tool of choice (CLAUDE.md, copilot-instructions.md, GEMINI.md, AGENTS.md, etc.) to include a rule to avoid adding emojis to anything when pushing out code to your github repos. I've set this up for some of my projects and it's relatively simple. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Simply structuring this a little nicer so that it's not screaming like AI helped generate the root readme.
Love what you guys are doing with providing the information to the world for free. Want to do my part wherever possible to help convey the message to others around the globe more easily.
Also recommend adding:
Please feel free to reach out if you ever need a PR review for anything related to automation. Would love to help make this something for others to leverage.
Cheers!