Clarify that IO documentation is specification-only - #3677
Merged
spmallette merged 1 commit intoSep 24, 2026
Merged
spmallette merged 1 commit into
spmallette merged 1 commit into
Conversation
The IO book documents the serialization formats for providers and advanced users implementing against them. Make explicit in books-and-voice.md that these files specify the wire and file format rather than teach how to read or write it in code, so examples that invoke a reader or writer belong in the reference and tutorial books instead. The existing guidance that format-illustrative snippets are appropriate is preserved. Assisted-by: Kiro:claude-opus-4.8
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3677 +/- ##
============================================
+ Coverage 76.35% 76.70% +0.34%
- Complexity 13424 14346 +922
============================================
Files 1012 1037 +25
Lines 60341 64761 +4420
Branches 7075 7695 +620
============================================
+ Hits 46076 49677 +3601
- Misses 11548 11989 +441
- Partials 2717 3095 +378 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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 IO book documents the serialization formats for providers and advanced users implementing against them. Make explicit in books-and-voice.md that these files specify the wire and file format rather than teach how to read or write it in code, so examples that invoke a reader or writer belong in the reference and tutorial books instead. The existing guidance that format-illustrative snippets are appropriate is preserved.