Skip to content

Conversation

@jonathanhefner
Copy link
Member

@jonathanhefner jonathanhefner commented Dec 10, 2025

Use #![doc = include_str!("../README.md")] to display README as crate documentation on docs.rs for both rmcp and rmcp-macros.

Changes to support this:

  • Fix code examples to compile as doc tests (rust,no_run)
  • Fix broken rustdoc links with explicit crate:: paths
  • Add "Structured Output" section and examples link to rmcp README
  • Simplify rmcp-macros README to a summary table with doc links
  • Fix grammar throughout
  • Add CSS to hide GitHub badges when rendered as rustdoc

🤖 Generated with Claude Code

Tip

To add new guide documentation in the future, create markdown files in a docs/ subdirectory and include them as doc modules in lib.rs:

#[doc = include_str!("../docs/guide-name.md")]
pub mod _guide_name {}

This creates navigable sections in docs.rs while keeping files maintainable.

Use `#![doc = include_str!("../README.md")]` to display README as crate
documentation on docs.rs for both `rmcp` and `rmcp-macros`.

Changes to support this:
- Fix code examples to compile as doc tests (`rust,no_run`)
- Fix broken rustdoc links with explicit `crate::` paths
- Add "Structured Output" section and examples link to rmcp README
- Simplify rmcp-macros README to a summary table with doc links
- Fix grammar throughout
- Add CSS to hide GitHub badges when rendered as rustdoc

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@github-actions github-actions bot added T-documentation Documentation improvements T-core Core library changes T-macros Macro changes labels Dec 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

T-core Core library changes T-documentation Documentation improvements T-macros Macro changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant