docs: rewrite the README around the schema you actually import - #30
Merged
Conversation
Same structural rewrite as openadapt-flow. The old file spent its first 30 lines on a status admonition and a stack table copied verbatim into five other repositories, then buried the code sample that shows what this package is. - Open with what the schemas are for and who else in the stack reads them, then the install line, then the code. - Move the overlay and business-decision wire-contract rules, about 45 lines of exact 'may not carry' language, into docs/CONTRACTS.md. Nothing deleted. - Turn the Design principles bullets into prose. Every bullet was a bolded phrase followed by a restatement of itself. - Verified against openadapt-types 0.10.1 from PyPI: to_text_tree() output, ActionTarget field names, the _compat converters, ExecuteClient, and the count of shipped JSON schema files. 265 lines to 154. Co-Authored-By: Claude Opus 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
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.
Part of the README pass across the public repos
(openadapt-flow#423
has the diagnosis).
This one was closer to fine than most: the code samples were good and the
targeting section was genuinely useful. The problems were at the top and the
bottom.
The top. Thirty lines before the reader saw a schema: a status admonition,
a paragraph about what the product is, a substrate maturity table, and a
package table. That block is copied word for word into five other repositories.
Reading it a fifth time doesn't tell anyone anything, and it pushes the actual
subject of the package below the fold.
The bottom. About 45 lines of exact wire-contract language ("target
geometry never carries locators, accessible names, values, URLs, or
screenshots", the HMAC reference rule, the coalescing rule for multiple runtime
states in one decoded frame). Every word of it matters to whoever implements a
renderer. None of it belongs in a README. It's now
docs/CONTRACTS.mdandnothing was cut.
The "Design principles" bullets became prose. Each one was a bolded phrase
followed by a sentence restating the bolded phrase, which is the most reliable
generated-text tell in the whole file.
Verified
openadapt-types==0.10.1installed from PyPI into a clean venv. I ran thequick-start sample and pasted its real
to_text_tree()output, checked theActionTargetfield names by constructing one, confirmed all six_compatconverters and
ExecuteClientimport, and counted the JSON schema files thatactually ship (19).
265 lines to 154. Zero em dashes.