Sharpen body-format and output-contract docs#5
Merged
Conversation
Third doc-review pass — documentation precision only, no code change.
- technical-design.md §5: split the --body-format note — `page create/update`
support storage|wiki|markdown, but `comment add/update` only storage|wiki.
- technical-design.md §6.4 (testing): the e2e suite asserts the stdout output
contract and exit codes, not "JSON" uniformly (raw-output exceptions, §6.1).
- README: the {items,next,has_more} envelope is the default JSON shape;
--format ndjson streams the items themselves instead.
Co-Authored-By: Claude Opus 4.7 <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
1 participant
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.
Third doc-review pass. Documentation precision only — no code change.
All three findings verified against the implementation.
--body-formatvalue sets —technical-design.md§5 mergedpage create/updateandcomment add/updateinto onestorage|wiki|markdownnote, butcomment add/updateonly acceptstorage|wiki. Now split: page supports markdown, comment does not.{items,next,has_more}envelope" unconditionally;--format ndjsonactually streams the items themselves. Now scoped to the default JSON
output, with the ndjson behaviour spelled out.
JSON"; corrected to "stdout output contract and exit codes", consistent
with the raw-output exceptions documented in §6.1 (
version,attachment download --output -,skill show).Verification
Docs-only;
go build/go testunaffected. Nodocs/cli/regenerationneeded (no command or flag change).
🤖 Generated with Claude Code