search

Agoric / documentation

User documentation
https://agoric.com/documentation/
Apache License 2.0
15 stars 40 forks source link

Docs Revamp - Key Takeaways from getting started with Offer Up Dapp #919

Closed sufyaankhan closed 6 months ago

sufyaankhan commented 7 months ago

After reviewing "Getting Started" Offer-up dapp, here are changes we need so the Developer journey is smooth.

  1. Under docs -> whats Agoric -> Takes you back to the home page https://docs.agoric.com/ Screenshot 2024-01-18 at 9 51 35 AM

Solution: This should take you to a single page defining what Agoric is (we are missing this page)

  1. Under ZOE heading (left side navigation bar) -> We have 3 attempts to define what actually ZOE is:
Screenshot 2024-01-18 at 9 53 44 AM

Solution: Deprecate 2 of the 3 pages. Consolidate information in to one.

  1. Contract Requirements and Price Authority pages both can be deprecated.

    Screenshot 2024-01-18 at 9 56 30 AM

  2. In the "Getting Started" section, we forget to formally introduce the "Offer Up" dapp. e.g. (something like) Your First Agoric Dapp - Offer Up Offer Up Dapp allows users to view all listed items up for sale in the marketplace. The Dapp shows 3 items by default. As a user you are able to choose up to 3 quantity of items (in any combination). You can then create an "offer" for an amount more than 0.25 IST. Once you sign the transaction, you will see the 3 items in your wallet and your wallet amount deducted by the Offer amount.

  3. In the end of "Getting Started" we should write a small paragraph about what should the developer take away from this exercise: e.g. Key Takeaways: In this lesson we showed you: How to start an Agoric Chain (re-show 1 line code) How to deploy a contract (re-show 1 line code) How to make an offer.. (re-show 1 line code)

  4. Deprecate the page "Synching on Mainnet"

    Screenshot 2024-01-18 at 10 02 45 AM

  5. Smart Wallet Dapp Architecture - This page needs to be re-written with the vision of "How to build a Client UI"

  6. Deploying Smart Contracts page - This should discuss our Offer Up dapp and re-write this page in its context.

### Tasks
- [x] Contract Requirements and Price Authority pages both can be deprecated
- [x] copy to introduce the "Offer Up" dapp
- [x] enumerate Key Takeaways from Getting Started
- [x] Deprecate the page "Synching on Mainnet"

tracked separately:

dckc commented 7 months ago

Deploying Smart Contracts page - This should discuss our Offer Up dapp and re-write this page in its context.

closely related:

dckc commented 7 months ago

920 took care of item 4

kbennett2000 commented 7 months ago

Item 5 addressed by #926

kbennett2000 commented 7 months ago

Item 6 addressed by #925

dckc commented 6 months ago

964 takes care of contract requirements, price authority (item 3) and enough of #918 for now, so I'm closing this.

For the last item, deployment, we have two other tickets tracking that:

"What is Agoric?" is perhaps an issue with the docs homepage, but not relevant to key takeaways from getting started.