Description
There is a gap in our documentation on docs.agoric.com in that we don't sufficiently explain/walk-through how a developer is supposed to a) build a client UI and b) connect it to a smart contract they've build on the Agoric chain.
https://docs.agoric.com/guides/getting-started/contract-rpc.html exists but it's more conceptual and background context - which while important to the reader/developer isn't a step-by-step guide on how to actually build the client UI.
Dapp-offer-up is a functional example contract and client UI that our docs reference in 'Getting Started' section (https://docs.agoric.com/guides/getting-started/) of our docs and in the 'Smart Contract Basics' section (https://docs.agoric.com/guides/zoe/contract-walkthru.html). It stands to reason that it the 'how to build a client UI' guide uses same smart contract for continuity and consistency. It will be easier for the developer/reader to follow along.
This ticket tracks the effort to document the step-by-step process through which a developer builds client UI (using dapp offer up as an example) and connect it to the offer up smart contract for full end-to-end functionality.
Requirements:
- Must reference dapp-offer-up contract and tie in with 'Getting Started' and 'Smart Contract Basics' such that it reads in a cohesive and easy-to-follow manner
- Must include instructions around how to query an RPC node to get data from contract
- Must reference utilization of UI components to simplify the UI building experience for developers
- Must use UI Kit (if UI kit explainer is needed, this needs to be incorporated)
- Must be written in step-by-step sequential format that is easy to follow
Acceptance Criteria:
- To ensure the how-to guide achieves our goal of being easy-to-follow and digest for developers - we will request review of @kbennett2000 (and maybe others) to follow along to elicit feedback. Iterations may be needed in order for us learn and improve on this.
- This will need to succeed before pushing to production docs.agoric.com
User Story: As a Developer I should be able to read the docs and get 2 things:
- Understanding of how to build a Client UI and make it interact with my deployed smart contract
- Get a repo/bundle of a sample Client UI that I could use to create my own Client
ui-kit and the basics of writing a dapp must be fully documented.
earlier idea:
- reorg "Smart Wallet Dapp Architecture"?
### Tasks
- [ ] Sam to propose how-to page structure