Docs improvements

[mr-zwets]

No description provided.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
cashscript	Ready	Preview, Comment	Jun 9, 2026 8:12am

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.33%. Comparing base (cd1c745) to head (897a2fe).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #409   +/-   ##
=======================================
  Coverage   86.33%   86.33%           
=======================================
  Files          51       51           
  Lines        3915     3915           
  Branches      733      733           
=======================================
  Hits         3380     3380           
  Misses        415      415           
  Partials      120      120           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[Copilot]

Pull request overview

This pull request updates the CashScript website documentation to improve clarity, fix typos/grammar, and align examples/type signatures with the current SDK and language behavior.

Changes:

• Fixes numerous typos/phrasing issues and improves consistency in headings and terminology.
• Updates SDK docs/examples to reflect current API shapes (e.g., DebugResults, WalletConnect types, locktime units).
• Expands/rewrites some guides (notably WalletConnect) and refines several conceptual guides (deployment, covenants, etc.).

Reviewed changes

Copilot reviewed 33 out of 33 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
website/docs/showcase.md	Minor wording cleanup in a showcase entry.
website/docs/sdk/typescript-sdk.md	Grammar fixes and heading capitalization.
website/docs/sdk/transaction-builder.md	Updates API docs (locktime example, debug return type, WC types, error shapes).
website/docs/sdk/testing-setup.md	Improves wording and updates examples (but one example still incorrectly uses addUtxo return value—see comments).
website/docs/sdk/other-network-providers.md	Updates vmTarget default VM version in docs.
website/docs/sdk/legacy-transaction-builder.md	Clarifies legacy builder status and removal version.
website/docs/sdk/examples.md	Updates example imports for ESM and modernizes example snippets.
website/docs/sdk/electrum-network-provider.md	Fixes typos and updates example network argument usage.
website/docs/releases/release-notes.md	Typos/wording fixes in release notes.
website/docs/releases/migration-notes.md	Grammar fixes in migration notes.
website/docs/language/types.md	Fixes sentence grammar in types section.
website/docs/language/syntax-highlighting.md	Simplifies Sublime section and removes Atom instructions.
website/docs/language/globals.md	Clarifies timelock wording and fixes tx.outputs[...] naming.
website/docs/language/functions.md	Fixes checkSig spelling/signature and related text.
website/docs/language/examples.md	Fixes typos and a variable name inconsistency in an example.
website/docs/language/contracts.md	Adds a note clarifying top-level contract functions vs reusable functions.
website/docs/guides/walletconnect.md	Major rewrite + adds WizardConnect documentation and updated examples/links.
website/docs/guides/optimization.md	Updates external reference link/name.
website/docs/guides/lifecycle.md	Fixes a grammar issue.
website/docs/guides/infrastructure.md	Grammar/wording improvements.
website/docs/guides/deployment.md	Substantial rewrite/clarification of deployment concepts and examples.
website/docs/guides/debugging.md	Updates getBitauthUri() usage to match sync API.
website/docs/guides/covenants.md	Fixes typos and variable naming in examples.
website/docs/guides/cashtokens.md	Fixes typos and adds a token ID byte-order helper snippet.
website/docs/guides/adversarial.md	Fixes grammar and link text.
website/docs/compiler/script-limits.md	Grammar fixes and wording improvements.
website/docs/compiler/grammar.md	Refines grammar production rules presentation.
website/docs/compiler/artifacts.md	Updates artifact schema docs to match current @cashscript/utils types.
website/docs/community-sdks/python-sdk.md	Capitalizes “Example” heading.
website/docs/basics/getting-started.md	Fixes multiple typos/grammar issues.
website/docs/basics/about.md	Fixes apostrophe usage and “TypeScript” capitalization.
website/docs/basics/about-bch.md	Fixes grammar/wording issues.
.cspell.json	Adds “defi” to dictionary.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.