Repository navigation
[Docs] Modernization: the README documents every method, option and error - #100
Merged
Merged
Conversation
fostimus
changed the title
fostimus
force-pushed
the
df/modernize-docs
branch
from
October 21, 2026 21:06
42d98ba to
ad48ffc
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
2 times, most recently
from
October 27, 2026 22:08
c0e8707 to
8d2de70
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
from
October 27, 2026 22:35
8d2de70 to
ba912f9
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
from
October 27, 2026 23:23
ba912f9 to
aa2a0dc
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
from
October 28, 2026 17:20
aa2a0dc to
faa6e61
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
from
October 28, 2026 17:26
faa6e61 to
ac4e5c2
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
3 times, most recently
from
October 28, 2026 17:52
22f27eb to
192a8d7
Compare
fostimus
force-pushed
the
df/modernize-docs
branch
2 times, most recently
from
October 28, 2026 22:09
b019250 to
41d03b4
Compare
The README now covers every method, option, error and the rate limiting the way node-anvil's does, plus the generated types and the CLI, so there is one place to keep current. The docs/ folder, mkdocs and the Read the Docs config go; their content is in the README. CONTRIBUTING.md gains the integration test script, the generated types and the sync workflow's requirements. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Only four payload models extend the generated types, not all of them; a misspelled option is kept as an extra field rather than rejected; the non-JSON error carries a body snippet; Retry-After is honored on every retried status and capped; and params, timeout and cast_args are listed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… and dict file kinds Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
fostimus
force-pushed
the
df/modernize-docs
branch
from
October 28, 2026 22:32
fd349de to
c9bfac7
Compare
fostimus
marked this pull request as ready for review
October 28, 2026 22:35
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
Layer 4 of 4, on #99. The README now documents every method, option, error and the rate limiting in node-anvil's structure, plus the generated types and the CLI, so there is one place to keep current.
docs/folder, mkdocs and the Read the Docs config go; their content is in the README.How to verify
Anvilhas a README section whose signature matchespython_anvil/api.pycreate_etch_packetdict example,forge_submitexample andCreateEtchPacketbuilder example run against the client (checked with the transport mocked)docs/Open workspace in Conductor