docs: align docs with shipped behavior (audit fixes) - #118
Merged
Conversation
A full audit of every tracked .md file against the current command/help surface and recent PRs (#103-#117) found gaps where a shipped change had not reached one or more docs. No behavioral defects and no branding/identifier leaks were found; these are documentation-only fixes. HIGH: - cmd/agents.md: document the v0.6.0 BREAKING envelope-unwrap in "Reading output" — typed `get` prints the resource flat (`.id`, not `.app.id`), naming a wrapper key in `--fields` exits 2, and `mcp servers get` has only `connectorId`. README already covered this; the agent-facing doc did not. - README.md: add the `docs search` no-relevance-threshold caveat (#117), which had reached help + `docs agents` but not README. - CHANGELOG.md: merge the duplicated `### Added`/`### Changed` headers in [Unreleased] into one block each (Added/Changed/Fixed); all 14 entries preserved verbatim. MED: - README.md: `policies` step_kinds/baseline_policy_id + the auto-approval jq recipe (#103); `mcp servers register --user-id` and the flags settable at register time. - cmd/agents.md: `mcp tools approve` takes multiple ids in one process (#116). - CLAUDE.md: document the shared repeatable-flag registrar convention (#111). LOW: - README.md: `--tool-id` caps (100/32), requestable-connectors non-pagination, `entitlements create --resource-type` default CUSTOM, `requests create --duration` is Go-style vs the protobuf-duration flags. - cmd/agents.md + skill: malformed-`--url` rejection (#115). - CLAUDE.md: negative `--limit`/`--page-size` rejection + page-size clamp. - .claude/commands/c1i.md: add `auth token`, the ~/.c1i.yaml wrong-tenant stderr warning, a pointer to the command groups, and the docs-search caveat. Every claim verified against `--help` or live behavior; embedded `docs agents` re-checked to render the new content. Build/vet/test/shuffle/lint/gosec/gitleaks /govulncheck all clean. Co-Authored-By: Claude Opus 4.8 <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
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.
A full audit of every tracked
.mdfile against the current command/help surface and recent PRs (#103–#117) found places where a shipped change hadn't reached one or more docs. No behavioral defects and no branding/identifier leaks were found — these are documentation-only fixes. Six Sonnet agents did the audit; a Sonnet reviewer verified every fix against--help/source.HIGH — a shipped change a doc missed
getprints the resource flat (.id, not.app.id), naming a wrapper key in--fieldsexits 2, andmcp servers gethas onlyconnectorId.docs searchno-relevance-threshold caveat (docs: state thatdocs searchhas no true no-match #117), which had reached--help+docs agentsbut not README.[Unreleased]had duplicated### Added/### Changedheaders (the merge-duplication pattern); merged to one Added/Changed/Fixed each. All 14 entries preserved verbatim.MED
policiesstep_kinds/baseline_policy_id+ the auto-approval jq recipe (feat: identify the auto-approval grant policy portably, via step_kinds #103);mcp servers register --user-idand the flags settable at register time.mcp tools approvetakes multiple ids in one process (feat(mcp): approve multiple tools in one invocation #116).LOW
--tool-idcaps (100/32), requestable-connectors non-pagination,entitlements create --resource-typedefaultCUSTOM,requests create --durationGo-style vs the protobuf-duration flags.--urlrejection (fix: reject malformed --url, correct TTY detection, document mixed-case re-login #115).--limit/--page-sizerejection + page-size clamp..claude/commands/c1i.md:auth token, the~/.c1i.yamlwrong-tenant stderr warning, a command-groups pointer, the docs-search caveat.Validation
Every claim verified against
--helpor live behavior (e.g.mcp servers getconfirmed to have noid); embeddeddocs agentsre-checked to render the new content. Build, vet, test,-shuffle=on, golangci-lint (0), gosec (0), gitleaks (clean), govulncheck (clean) — andTestReadmeCommandsResolveAgainstCobraTree(138c1iinvocations resolve). Independent Sonnet review found nothing to flag.🤖 Generated with Claude Code