Skip to content

Rewrite public docs for the 0.6.0 API - #6

Merged
UTXOnly merged 1 commit into
mainfrom
doc-updates
Sep 12, 2026
Merged

Rewrite public docs for the 0.6.0 API#6
UTXOnly merged 1 commit into
mainfrom
doc-updates

Conversation

@UTXOnly

@UTXOnly UTXOnly commented Sep 12, 2026

Copy link
Copy Markdown
Owner

Summary

  • Rewrite the README around install, the 0.6.0 services, retry policy, and WebSocket gotchas instead of a method catalog and a ptr helper that is not in the module.
  • Align example READMEs and the test rule with what the client actually covers; ignore local *-pre-release-review.md / plan files so they stay out of the public tree.

Test plan

  • Confirm v0.6.0-pre-release-review.md is not in the PR diff
  • README still pins @v0.6.0 (CI version job)
  • Snippets compile: no ptr(...), DoConcurrent takes maxInFlight, CreateV2 shows client_order_id

Made with Cursor

… of git.

The README was a method catalog with examples that did not compile; point at the real services, retry policy, and WebSocket gotchas instead.

Co-authored-by: Cursor <cursoragent@cursor.com>
@UTXOnly
UTXOnly merged commit 729c25c into main Sep 12, 2026
7 checks passed
@UTXOnly
UTXOnly deleted the doc-updates branch September 12, 2026 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant