collapse docs from readme #580
Open
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces collapsible sections in the README to make the Tools and Resources lists more navigable.
- Wrap each major Tools category under
<details>/<summary>blocks - Wrap each Resources subsection under
<details>/<summary>blocks
Comments suppressed due to low confidence (1)
README.md:431
- [nitpick] The summary here reads "Context" but is wrapping the user-related tool
get_me. Rename it toUsersto match the section content and maintain consistency.
<summary>Context</summary>
|
|
||
| <details> | ||
|
|
||
| <summary>Users</summary> |
There was a problem hiding this comment.
User tools (get_me and search_users) are split into two separate collapsible sections. Consider merging them into a single Users block to avoid duplication and improve organization.
Copilot uses AI. Check for mistakes.
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.
Closes:
The readme is getting too big and confusing. This is the first of a few refactors to reduce the size of the root readme and to improve readability.
See here for a rendered version.