Ensure every heading is followed by a paragraph before any code block,
list, table, or other content. Also add this as a documentation guideline
in CLAUDE.md.
Consolidate the separate README.v2.md and docs/ pytest-examples tests
into a single unified test using `find_examples("README.v2.md", "docs/")`.
Add skip tags to pre-existing code blocks that aren't self-contained:
- migration.md: all blocks (before/after migration patterns)
- experimental/*.md: all blocks (experimental API patterns)
- testing.md: test blocks (reference local server module)
- README.v2.md: 4 context-dependent snippets
Every Python code block in docs pages is now both linted and executed
by pytest-examples.
- Make all concepts.md examples self-contained with proper imports
- Add test_docs_examples_run that executes every doc code block
- Use __name__ override to prevent `if __name__ == "__main__"` blocks
from starting servers during tests
- Support skip-run/skip-lint prefix tags for future use
- Drop snippet-source from quickstart.md so the example is
self-contained
- Add docs/quickstart.md and docs/concepts.md to pytest-examples so
all code blocks in documentation are linted by ruff
- Fix f-string in concepts.md Prompts example that contained backticks
causing a syntax error when parsed standalone
Remove all empty "Under Construction" placeholder pages for server/
and client/ directories. Only pages with actual content should exist.
- Remove docs/server/ and docs/client/ placeholder pages
- Strip mkdocs.yml nav to only pages with real content
- Remove broken links from concepts.md and quickstart.md (replaced
with TODO comments for when those pages are created)
- Simplify index.md by removing card grid linking to non-existent pages
Set up the foundation for migrating documentation from README.v2.md
into proper docs pages served by mkdocs.
- Rewrite `docs/index.md` as a concise landing page with card grid
- Add `docs/quickstart.md` with a complete getting-started guide
- Fill `docs/concepts.md` with protocol architecture, primitives,
transports, context, and lifecycle overview
- Restructure `mkdocs.yml` nav into Server, Client, and top-level
sections
- Create `docs/server/` and `docs/client/` directories with
placeholder pages for upcoming content
- Move `docs/low-level-server.md` to `docs/server/low-level.md`
Marcelo Trylesinski