docs: Fix markdown formatting and file references #4096#4097
Open
0xnithin-ai wants to merge 1 commit intomodelcontextprotocol:mainfrom
Open
docs: Fix markdown formatting and file references #4096#40970xnithin-ai wants to merge 1 commit intomodelcontextprotocol:mainfrom
0xnithin-ai wants to merge 1 commit intomodelcontextprotocol:mainfrom
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
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.
Description
This pull request addresses several formatting and referential bugs found within the
EverythingMCP server documentation.These documentation errors were breaking the rendering of the
README.mdon GitHub/NPM and providing confusing or mislabeled file references to developers.Changes Made
Broken Markdown Rendering in
README.mdsrc/everything/README.mdwhere an installation code block was closed with 4 backticks (````) instead of 3 (```), which was breaking the remainder of the markdown rendering on the page.Incorrect Tool Filename in
features.mdsrc/everything/docs/features.md. Changedtools/trigger-trigger-long-running-operation.tstotools/trigger-long-running-operation.ts.Mislabeled Instructions File (
startup.md&structure.md)src/everything/docs/startup.mdandsrc/everything/docs/structure.mdfromserver-instructions.mdtoinstructions.mdto match the actual file name.Self-Referential Errors in
structure.mddocs/folder outline insrc/everything/docs/structure.md:architecture.mdproperly as "Architectural overview."structure.mdto the tree and correctly labeled it as "This document."instructions.md.Related Issues
Fixes #4096
Testing