Skip to content

docs: plain-language pass on the docs site and README - #733

Merged
imran-siddique merged 2 commits into
mainfrom
docs/plain-language
Oct 8, 2026
Merged

imran-siddique merged 2 commits into
mainfrom
docs/plain-language

Conversation

@imran-siddique

Copy link
Copy Markdown
Member

Home, Get started, all tutorials and testing pages are rewritten in plain words; SPEC, the spec pages and ADR 0001 get plain lead-ins only, with no MUST/SHOULD sentence changed. Detail such as the TRACE claim field table and the Cedar request build moves into collapsible Technical detail blocks. Fixes: catalog_exception is documented as a bool defaulting to false (catalog/loader.py:77), spec-index drops the row for a page removed in 91d74bb, benchmarks.md no longer claims committed results, and the Azure guide names DCesv6. mkdocs build --strict passes; every fenced code block is byte-identical to main.

Part of the plain-language pass across AgenTrust, alongside agentrust-io/agentrust-io.github.io#97.

🤖 Generated with Claude Code

imran-siddique and others added 2 commits October 7, 2026 14:12
Every published docs page and the README opening now start with a short
plain explanation, and terms are defined at first use. Guide pages are rewritten in
ordinary words with deep detail in "Technical detail" admonitions. Spec and ADR
pages get lead-ins only. Code blocks, normative text and headings that pages link to are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…nt TDX VM

catalog_exception is a bool defaulting to false (catalog/loader.py:77).
mcp-spec-strategy.md was removed in 91d74bb, so spec-index no longer lists it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@Qiang-Xu Qiang-Xu left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

Comment thread docs/sponsors.md
@@ -1,5 +1,7 @@
# Sponsors

This page says who pays for cMCP and how other organisations can help.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe who funds cMCP and how your organization can help?

@imran-siddique
imran-siddique merged commit 9deea16 into main Oct 8, 2026
17 checks passed
@imran-siddique
imran-siddique deleted the docs/plain-language branch October 8, 2026 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants