From d437c81cbeeaecde495897ce843905cb1713585f Mon Sep 17 00:00:00 2001 From: CSK <73425927+cr2007@users.noreply.github.com> Date: Fri, 18 Jul 2025 16:43:47 +0400 Subject: [PATCH] docs: Enhance README formatting and fix relative links (#146) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This PR improves the formatting and internal link structure of both the main `README.md` and the source file at `internal/readme/README.src.md`. Changes include: ### 🛠 Changes Made * Replaced plain-text warning with a GitHub-style admonition block (`> [!WARNING]`) for improved visibility and consistency with other docs. Example: > [!WARNING] > The SDK should be considered unreleased, and is currently unstable > and subject to breaking changes. Please test it out and file bug reports or API > proposals, but don't use it in real projects. See the issue tracker for known > issues and missing features. We aim to release a stable version of the SDK in > August, 2025. * Updated markdown links to use cleaner relative paths: * Changed `CONTRIBUTING.md` reference to `[CONTRIBUTING.md](/CONTRIBUTING.md)` * Updated `examples/` reference to `[examples/](/examples/)` * Ensured that all updates were mirrored in both the generated and source README files. ### 📌 Why It Matters These changes improve the readability and usability of the documentation, especially when viewed on GitHub. The updated formatting helps call attention to important warnings, and fixing relative paths ensures that links work reliably across platforms and contexts. --- README.md | 15 ++++++++------- internal/readme/README.src.md | 15 ++++++++------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 037885e..d899afd 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,12 @@ https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.2.0) for details. This repository contains an unreleased implementation of the official Go software development kit (SDK) for the Model Context Protocol (MCP). -**WARNING**: The SDK should be considered unreleased, and is currently unstable -and subject to breaking changes. Please test it out and file bug reports or API -proposals, but don't use it in real projects. See the issue tracker for known -issues and missing features. We aim to release a stable version of the SDK in -August, 2025. +> [!WARNING] +> The SDK should be considered unreleased, and is currently unstable +> and subject to breaking changes. Please test it out and file bug reports or API +> proposals, but don't use it in real projects. See the issue tracker for known +> issues and missing features. We aim to release a stable version of the SDK in +> August, 2025. ## Design @@ -28,7 +29,7 @@ Further design discussion should occur in [issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete proposals) or [discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for -open-ended discussion. See CONTRIBUTING.md for details. +open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details. ## Package documentation @@ -130,7 +131,7 @@ func main() { } ``` -The `examples/` directory contains more example clients and servers. +The [`examples/`](/examples/) directory contains more example clients and servers. ## Acknowledgements diff --git a/internal/readme/README.src.md b/internal/readme/README.src.md index 5f0f152..0e239f8 100644 --- a/internal/readme/README.src.md +++ b/internal/readme/README.src.md @@ -11,11 +11,12 @@ https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.2.0) for details. This repository contains an unreleased implementation of the official Go software development kit (SDK) for the Model Context Protocol (MCP). -**WARNING**: The SDK should be considered unreleased, and is currently unstable -and subject to breaking changes. Please test it out and file bug reports or API -proposals, but don't use it in real projects. See the issue tracker for known -issues and missing features. We aim to release a stable version of the SDK in -August, 2025. +> [!WARNING] +> The SDK should be considered unreleased, and is currently unstable +> and subject to breaking changes. Please test it out and file bug reports or API +> proposals, but don't use it in real projects. See the issue tracker for known +> issues and missing features. We aim to release a stable version of the SDK in +> August, 2025. ## Design @@ -27,7 +28,7 @@ Further design discussion should occur in [issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete proposals) or [discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for -open-ended discussion. See CONTRIBUTING.md for details. +open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details. ## Package documentation @@ -58,7 +59,7 @@ with its client over stdin/stdout: %include server/server.go - -The `examples/` directory contains more example clients and servers. +The [`examples/`](/examples/) directory contains more example clients and servers. ## Acknowledgements