[Doc] Reorganize README to surface key information earlier#298
Open
koic wants to merge 3 commits intomodelcontextprotocol:mainfrom
Open
[Doc] Reorganize README to surface key information earlier#298koic wants to merge 3 commits intomodelcontextprotocol:mainfrom
koic wants to merge 3 commits intomodelcontextprotocol:mainfrom
Conversation
Custom methods are an advanced feature and may not be appropriate for the top of the README.md. Move them to the bottom of the page. Only sections were reorganized with headings. No content was changed.
Users are more likely to want to see Usage first, rather than a feature introduction like Sampling. Sampling has been moved below Resource Templates so that Usage appears at the top. Only sections were moved. No content was changed.
For Usage, stdio is easier to try first than a Rails controller. Moved stdio to the top and placed Rails Controller after it. Only sections were moved. No content was changed.
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
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.
Motivation and Context
While working on #295 and #297, it became clear that the current README.md does not surface the information users are likely looking for at the top. As a result, I have reorganized the overall structure from a user’s perspective.
There is likely still room for further improvements, but even at this stage, the structure should be more useful than before.
This PR intentionally splits the changes into three commits.
Only sections were reorganized with headings. No content was changed.
Types of changes
Checklist