Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
4 tasks done
sufyaankhan opened this issue Jan 18, 2024 · 5 comments
Closed
4 tasks done
Assignees

Comments

@sufyaankhan
Copy link

sufyaankhan commented Jan 18, 2024

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:
  • Zoe Overview
  • Zoe Offer Safety Enforcement
  • Offer Safety
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
  1. 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.

  2. 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)

  3. Deprecate the page "Synching on Mainnet"

Screenshot 2024-01-18 at 10 02 45 AM
  1. Smart Wallet Dapp Architecture - This page needs to be re-written with the vision of "How to build a Client UI"
  2. Deploying Smart Contracts page - This should discuss our Offer Up dapp and re-write this page in its context.

Tasks

tracked separately:

@dckc dckc transferred this issue from Agoric/agoric-sdk Jan 18, 2024
@dckc
Copy link
Member

dckc commented Jan 18, 2024

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

closely related:

@dckc
Copy link
Member

dckc commented Jan 18, 2024

#920 took care of item 4

@kbennett2000
Copy link
Contributor

Item 5 addressed by #926

@kbennett2000
Copy link
Contributor

Item 6 addressed by #925

@dckc dckc changed the title Docs Revamp - Key Takeaways from Offer Up Dapp Docs Revamp - Key Takeaways from getting started with Offer Up Dapp Jan 26, 2024
@dckc
Copy link
Member

dckc commented Feb 6, 2024

#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.

@dckc dckc closed this as completed Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants