FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Rebuild the docs around tested examples; shrink README.v2.md to a pitch by maxisbey · Pull Request #2978 · modelcontextprotocol/python-sdk · GitHub

/ python-sdk Public

Rebuild the docs around tested examples; shrink README.v2.md to a pitch #2978

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxisbey merged 9 commits into from
Jun 26, 2026
Conversation 33 Commits 9 Checks 33 Files changed
Merged

Rebuild the docs around tested examples; shrink README.v2.md to a pitch #2978

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0fc6397
Rebuild the docs around tested examples; shrink README.v2.md to a pitch
maxisbey Jun 25, 2026
ef034d9
docs: write the rest of the tutorial — 26 chapters, every example tested
maxisbey Jun 25, 2026
bbfd087
docs: assert CORS behavior, not starlette internals; drop pragmas the…
maxisbey Jun 25, 2026
cf99d94
docs: plain ASCII punctuation throughout; rename the "Check it" sections
maxisbey Jun 25, 2026
f281961
docs: hold the docs' test prose to the same typography rule
maxisbey Jun 26, 2026
40dda12
docs: act on review feedback; fix the ASGI chapter's deployment story
maxisbey Jun 26, 2026
1a5f5de
docs: pin the landing page install command; wait on an event in the p…
maxisbey Jun 26, 2026
12c4cd9
docs: point the install commands at the 2.0.0a3 release
maxisbey Jun 26, 2026
42fcffd
docs: quote the tools/list schemas exactly as the SDK sends them
maxisbey Jun 26, 2026
File filter

Filter by extension

Filter by extension .md  (36) .py  (157) .toml  (1) .yaml  (1) .yml  (3) All 5 file types selected
Only manifest files
Deleted files Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
3 changes: 3 additions & 0 deletions .github/workflows/deploy-docs.yml
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ on:
- v1.x
paths:
- docs/**
# docs pages include their code blocks from these files via `--8<--`, so a
# change here changes the rendered site even when no .md file moves.
- docs_src/**
- mkdocs.yml
- src/mcp/**
- scripts/build-docs.sh
Expand Down
23 changes: 23 additions & 0 deletions .github/workflows/shared.yml
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,26 @@ jobs:

- name: Check README snippets are up to date
run: uv run --frozen scripts/update_readme_snippets.py --check --readme README.v2.md

# `mkdocs.yml` sets `strict: true` and `pymdownx.snippets: check_paths: true`,
# but until this job existed the docs were only ever built post-merge by
# `deploy-docs.yml`, so a broken link, a missing nav target, or a deleted
# `docs_src/` include went green on the PR and broke the next deploy of main.
# This is the check path; `deploy-docs.yml` stays the deploy path.
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
with:
persist-credentials: false

- uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
with:
enable-cache: true
version: 0.9.5

- name: Install dependencies
run: uv sync --frozen --all-extras --python 3.10

- name: Build the docs in strict mode
run: uv run --frozen --no-sync mkdocs build --strict
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Show comments
View file
Open in desktop
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
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -65,5 +65,5 @@ repos:
name: Check README snippets are up to date
entry: uv run --frozen python scripts/update_readme_snippets.py --check
language: system
files: ^(README\.v2\.md|examples/.*\.py|scripts/update_readme_snippets\.py)$
files: ^(README\.v2\.md|docs_src/.*\.py|examples/.*\.py|scripts/update_readme_snippets\.py)$
pass_filenames: false
Loading
Loading
Back | FazBrowse Home | New Git URL