Skip to content

Commit d437c81

Browse files
authored
docs: Enhance README formatting and fix relative links (#146)
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.
1 parent dd49b70 commit d437c81

File tree

2 files changed

+16
-14
lines changed

2 files changed

+16
-14
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.2.0) for details.
1212
This repository contains an unreleased implementation of the official Go
1313
software development kit (SDK) for the Model Context Protocol (MCP).
1414

15-
**WARNING**: The SDK should be considered unreleased, and is currently unstable
16-
and subject to breaking changes. Please test it out and file bug reports or API
17-
proposals, but don't use it in real projects. See the issue tracker for known
18-
issues and missing features. We aim to release a stable version of the SDK in
19-
August, 2025.
15+
> [!WARNING]
16+
> The SDK should be considered unreleased, and is currently unstable
17+
> and subject to breaking changes. Please test it out and file bug reports or API
18+
> proposals, but don't use it in real projects. See the issue tracker for known
19+
> issues and missing features. We aim to release a stable version of the SDK in
20+
> August, 2025.
2021
2122
## Design
2223

@@ -28,7 +29,7 @@ Further design discussion should occur in
2829
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
2930
proposals) or
3031
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
31-
open-ended discussion. See CONTRIBUTING.md for details.
32+
open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
3233

3334
## Package documentation
3435

@@ -130,7 +131,7 @@ func main() {
130131
}
131132
```
132133

133-
The `examples/` directory contains more example clients and servers.
134+
The [`examples/`](/examples/) directory contains more example clients and servers.
134135

135136
## Acknowledgements
136137

internal/readme/README.src.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ https://github.com/modelcontextprotocol/go-sdk/releases/tag/v0.2.0) for details.
1111
This repository contains an unreleased implementation of the official Go
1212
software development kit (SDK) for the Model Context Protocol (MCP).
1313

14-
**WARNING**: The SDK should be considered unreleased, and is currently unstable
15-
and subject to breaking changes. Please test it out and file bug reports or API
16-
proposals, but don't use it in real projects. See the issue tracker for known
17-
issues and missing features. We aim to release a stable version of the SDK in
18-
August, 2025.
14+
> [!WARNING]
15+
> The SDK should be considered unreleased, and is currently unstable
16+
> and subject to breaking changes. Please test it out and file bug reports or API
17+
> proposals, but don't use it in real projects. See the issue tracker for known
18+
> issues and missing features. We aim to release a stable version of the SDK in
19+
> August, 2025.
1920
2021
## Design
2122

@@ -27,7 +28,7 @@ Further design discussion should occur in
2728
[issues](https://github.com/modelcontextprotocol/go-sdk/issues) (for concrete
2829
proposals) or
2930
[discussions](https://github.com/modelcontextprotocol/go-sdk/discussions) for
30-
open-ended discussion. See CONTRIBUTING.md for details.
31+
open-ended discussion. See [CONTRIBUTING.md](/CONTRIBUTING.md) for details.
3132

3233
## Package documentation
3334

@@ -58,7 +59,7 @@ with its client over stdin/stdout:
5859

5960
%include server/server.go -
6061

61-
The `examples/` directory contains more example clients and servers.
62+
The [`examples/`](/examples/) directory contains more example clients and servers.
6263

6364
## Acknowledgements
6465

0 commit comments

Comments
 (0)