docs(dx-081-084): developer docs and contract reference - #621
Merged
Conversation
… and exchange-router docs - DX-081: Write /developers/architecture covering monorepo map, data flow, state locations, and repository invariants - DX-082: Write /developers/local-setup with prerequisites, clone/install steps, dev server, commit gate, and failure modes - DX-083: Generate contract address reference page from contracts.json with contract descriptions and ContractAddress component - DX-084: Document ExchangeRouter contract with role, all public functions, ParamTable component, and worked example Resolves SO4-Markets#593 Resolves SO4-Markets#594 Resolves SO4-Markets#595 Resolves SO4-Markets#596
|
@auraroom is attempting to deploy a commit to the Ijai's projects Team on Vercel. A member of the Team first needs to authorize it. |
|
@auraroom Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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.
What
Add comprehensive developer documentation: architecture overview, local setup guide, contract address reference, and ExchangeRouter contract documentation.
Issues Resolved
Closes #593
Closes #594
Closes #595
Closes #596
Changes
#593 - DX-081: Write /developers/architecture
Monorepo map covering apps/web, apps/s03-indexer, packages/contracts, packages/ui, packages/vitest-config. Data flow from Soroban contracts through RPC and indexer to web app. Where state lives: contract storage, indexer database, TanStack Query, Zustand, localStorage. Repository invariants: generated bindings are hand-adapted, dependency declaration, indexer codegen, design token rules.
#594 - DX-082: Write /developers/local-setup
Prerequisites with Node.js ≥20 and Bun 1.3.13. Clone, install with frozen lockfile, and running dev servers. The commit gate checks explained. Failure modes with solutions: undeclared dependencies, stale contract bindings, regeneration breaking build, clean-room verification.
#595 - DX-083: Generate contract address reference page
Generator script reads contracts.json and contract descriptions to emit contracts.generated.mdx. Per contract: name, ID, network, Stellar Expert link, and one-line role. Renders null IDs as "not deployed". Added contract descriptions mapping for all contracts.
#596 - DX-084: Document ExchangeRouter contract
Contract's role as entry point for trading. All public functions: create_order, cancel_order, claim_funding_fees with signatures, parameters with types/units, return values, auth requirements, and error codes. ParamTable component for parameters. Worked example opening a 2x long position on TETH/TUSDC. Note on hand-adapted bindings.