Skip to content

Add guides to the Symbiosis Swidge documentation - #1

Open
alexn-ops wants to merge 3 commits into
pr212-basefrom
feature/symbiosis-swidge-guides
Open

Add guides to the Symbiosis Swidge documentation#1
alexn-ops wants to merge 3 commits into
pr212-basefrom
feature/symbiosis-swidge-guides

Conversation

@alexn-ops

@alexn-ops alexn-ops commented Jul 31, 2026

Copy link
Copy Markdown
Owner

Adds a USDT0/Orchestra-style Guides section to the Symbiosis Swidge module documentation and updates the section to the released @symbiosis-finance/wdk-protocol-swidge-symbiosis@1.3.0, on top of the Symbiosis pages from tetherto#212 (branch pr212-base mirrors ihsraham:feat/release-docs-2026-07-27).

Changes

  • New guides:
    • Get Started — install, source account, provider construction, discovery, quote-only use.
    • Quote and Execute — exact-input options, indicative quotes, review checklist, EVM execution with the allowance-reset flow, fee caps.
    • Bridge from Bitcoin — deposit-address routes, refund address, swap-endpoint rate limit.
    • Track Settlement — durable operation IDs, polling with a deadline, status mapping, refunds.
    • Handle Errors — typed error family, pre-write vs post-write failures, safe retries, account disposal.
  • Sidebar: a Guides group under the Symbiosis folder in custom-tree.ts; a Get Started card on the module overview.
  • Release 1.3.0 (tag, npm) across the four existing pages, the module catalogs, and the guides: TON, Tron and Solana source routes execute when the bound wallet account supports the required transaction format, probed at execution time (raw BoC bodies for single-message TON routes, contract calls plus TRC-20 approvals for Tron with receipt-failure detection, serialized transactions for Solana); wallet versions without the capability stay quote-only with UnsupportedRouteError.
  • USDT terminology aligned across the section; link to the repository's runnable examples/swidge.js.

Every guide carries the community responsibility disclaimer and docType/schemaType frontmatter. Guide content was fact-checked against the module source (v1.3.0 tag) — behavior claims, error classes and fields, status mapping, snippet APIs.

Validation

  • check:meta, check:redirects, check:links (internal + anchors): 302 MDX files, 0 errors.
  • Full static build and llms.txt/llms-full.txt regeneration not run locally (no GitHub Packages access for @tetherto/docs-seo-*); to be regenerated before proposing upstream.

Five task-focused guides for @symbiosis-finance/wdk-protocol-swidge-symbiosis
1.2.0, following the structure used by the USDT0 and Orchestra module docs:
Get Started, Quote and Execute, Bridge from Bitcoin, Track Settlement, and
Handle Errors. Wire them into the sidebar tree and the module overview cards.
Reflect the released 1.3.0 behavior: TON, Tron and Solana source routes now
execute when the bound wallet account supports the required transaction
format, probed at execution time (raw BoC message bodies for single-message
TON routes, smart contract calls plus TRC-20 approvals for Tron, serialized
transactions for Solana); older wallet versions stay quote-only. Tron
approval receipts are checked for on-chain failure. Also align USDT
terminology across the section, link the repository's runnable example, and
tighten the error-table wording.
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.

2 participants