Skip to content

docs: onboarding aids (EVM comparison, worked example, error table, builder recipe) + SDK version fix - #133

Merged
srikanth-bitdynamics merged 1 commit into
mainfrom
docs/onboarding-enhancements
Aug 17, 2026
Merged

docs: onboarding aids (EVM comparison, worked example, error table, builder recipe) + SDK version fix#133
srikanth-bitdynamics merged 1 commit into
mainfrom
docs/onboarding-enhancements

Conversation

@srikanth-bitdynamics

Copy link
Copy Markdown
Owner

Adds newcomer-onboarding material and fixes a version discrepancy.

  • Overview — an EVM/Uniswap comparison table mapping approve, the router, LP balances, and reserve0/1 to the Canton equivalents, for developers arriving with a Uniswap mental model.
  • Liquidity and custody — a numeric worked example tracing one full cycle (fund 10 BTC + 200,000 USDC, swap 1 BTC, redeem), with figures taken from the on-ledger floored Decimal math.
  • HTTP API reference — an on-ledger assertion table mapping the real Daml assert messages to their trigger and the suggested client handling.
  • Builder guide — a concrete first-change recipe (edit Daml, dpm build, dpm test, then see examples/stable-pool consume the DAR).
  • README — the Daml SDK badge and prerequisite now read 3.5.2 (managed by dpm), matching trading/daml.yaml and the other packages.

Verified: links and anchors resolve, no stale wording, the docs governance/scope tests pass, and the site builds.

Add an EVM/Uniswap comparison table, a numeric worked example, an on-ledger
assertion table, a first-change recipe, order and pool state-machine
diagrams, and a module-dependency graph across the concept, guide, and
reference docs, plus a one-command smoke-test callout in getting started.
Correct the README Daml SDK version to 3.5.2 to match the daml.yaml files.
@srikanth-bitdynamics
srikanth-bitdynamics force-pushed the docs/onboarding-enhancements branch from b384b84 to 3409e1d Compare August 17, 2026 02:50
@srikanth-bitdynamics
srikanth-bitdynamics merged commit 8d9a189 into main Aug 17, 2026
7 checks passed
@srikanth-bitdynamics
srikanth-bitdynamics deleted the docs/onboarding-enhancements branch August 17, 2026 02:59
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