Repository navigation
docs: plain-language pass on the docs site and README - #80
Merged
Merged
Conversation
README opens with what the project records and who it is for, and explains spans, digests and fixtures at first use. Each docs/*.md page gets a plain opening paragraph above the unchanged technical text. Fixes the brand spelling (AgentTrust to AgenTrust) in this prose; contract version 0.1.0-alpha.6 confirmed against the v0.1.0-alpha.6 release and check_versions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README and every docs page now open by saying what is recorded, who uses it and what you get, with spans, digests and fixtures explained at first use. "AgentTrust" is corrected to "AgenTrust" in prose. The contract version stays 0.1.0-alpha.6. check_otel_compatibility, check_versions, the TypeScript schema check and repository gates pass.
Part of the plain-language pass across AgenTrust, alongside agentrust-io/agentrust-io.github.io#97.
🤖 Generated with Claude Code