fix: correct 4 documentation inaccuracies found by docs-validation suite#42
Merged
Conversation
- Fix version output format: actual is 'capiscio version X.Y.Z (commit: hash)' not 'capiscio/X.Y.Z (os-arch)' (2-install.md) - Add missing protocolVersion to agent card examples that would fail validation (3-validate.md, complete-workflow.md, sample assets) - Fix claims docs: iss is not present in dev_mode, only iat/exp/bh (1-intro.md, 2-sdk.md, 3-guard.md) - Add dev_mode trust warning: verify_inbound() accepts all valid Ed25519 signatures in dev_mode; trust store enforcement requires configured keys or CapiscioMiddleware (3-guard.md)
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
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
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.
Summary
Fixes 4 documentation inaccuracies discovered by the automated docs-validation test suite (
capiscio-e2e-tests/docs-validation/).Findings & Fixes
1. CLI
--versionoutput format (Low severity)capiscio/X.Y.Z (darwin-arm64)capiscio version X.Y.Z (commit: <hash>)getting-started/validate/2-install.md2. Missing
protocolVersionin agent card examples (High severity)MISSING_PROTOCOL_VERSIONerrorgetting-started/validate/3-validate.md,getting-started/complete-workflow.md,assets/samples/agent-card.json,assets/samples/agent-card-full.json3.
issclaim not present in dev_mode (Medium severity)issin example output, butverify_inbound()in dev_mode only returnsiat,exp,bhclaims['iss']would raiseKeyErrorgetting-started/secure/1-intro.md,getting-started/secure/2-sdk.md,getting-started/secure/3-guard.mdissis production-only, used.get('iss', 'dev-mode agent')fallback4. Dev mode trust store behavior (Medium severity)
dev_mode=True,verify_inbound()actually accepts any valid Ed25519 signatureCapiscioMiddlewaregetting-started/secure/3-guard.mdValidation
All findings discovered and verified by the
capiscio-e2e-tests/docs-validation/test suite: