-
Notifications
You must be signed in to change notification settings - Fork 1
[Docs] API Reference β Full documentation for all contract entry points and SDK methodsΒ #1
Copy link
Copy link
Open
Description
π Description
Write the complete API reference documentation for Alien Gateway, covering all Soroban contract entry points and all TypeScript SDK methods. This documentation will live in docs/ and be linked from the README.
β Requirements
- Document all public contract entry points:
submit_proof,resolve,add_stellar_address,add_chain_address,set_memo,create_vault,deposit,withdraw,schedule_payment - Document all SDK methods:
resolveUsername,sendToUsername,fetchProxyAddress,verifyOwnership - Include input/output types, error codes, and example calls for each
- Markdown format, clear headings, and code examples
π― Acceptance Criteria
- All contract entry points documented with inputs, outputs, errors
- All SDK methods documented with TypeScript usage examples
-
docs/api-reference.mdexists and is linked fromREADME.md - No broken links or code examples that do not match actual implementation
π Expected files to change/structure
docs/api-reference.mdβ new fileREADME.mdβ add link to docs
πΏ Branch:
docs/api-reference| Priority: LOW | Difficulty: β one-coffee
Reactions are currently unavailable