Agoric / documentation

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

Improvements to Orchestration Key-Concepts Page #1201

Closed amessbee closed 1 month ago

amessbee commented 2 months ago

Here is a list of changes:

  1. Fixed errors in the structure + grammar
  2. Removed ICA figure from cosmos (theme looks out of place in our docs)
  3. Merged Key Concepts and API pages as they had, somewhat, fluffy content.

Orchestration Key Concept Page Rendered

Refs:

cloudflare-workers-and-pages[bot] commented 2 months ago

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: ecb07fb
Status: ✅  Deploy successful!
Preview URL: https://569ff001.documentation-7tp.pages.dev
Branch Preview URL: https://ms-update-orch-concepts.documentation-7tp.pages.dev

View logs

github-actions[bot] commented 2 months ago

Cloudflare deployment logs are available here

mitdralla commented 2 months ago
image image

Example: "Creating your Dapp from a Template" -> "Creating from a Template" Example: "Starting the Dapp Smart Contract" -> "Starting the Smart Contract"

or visit https://classic.yarnpkg.com/en/docs/install for more information -> or visit the official yarn package

amessbee commented 2 months ago

@mitdralla thanks for your comments. They are very helpful and I or @mujahidkay will create a separate issue based on your feedback. My current PR is about a (key concepts and APIs) page in our new orchestration section. If you can also provide feedback on that it would be great. Below is a direct link to the updated page that needs to be reviewed:

Orchestration Key Concepts

Sorry for the confusion - I should have been clearer when I requested feedback. Looking forward.

mitdralla commented 2 months ago

One more item which is minor - there is a missing space: "asAmountconverts a denom amount to an Amount with a brand."

image
turadg commented 1 month ago

Removing myself. This is DevRel purview.

amessbee commented 1 month ago

@Jovonni thanks a lot for detailed review and comments. In essence, what we are doing here, everything that is not absolutely necessary for devs and posting it in a separate page: PR #1209. We want this page to be magical and really abstract out all the details, conveying the message that if you need to orchestrate it is as simple as calling getChain, makeAccount, and then tansfer for you and Agoric will take care of everything under-the-hood, and BTW if you need to know what's going on under-the-hood, here is an other page with details.

WDYT?

amessbee commented 1 month ago

LGTM 🚀 , this is the only thing to address: https://github.com/Agoric/documentation/pull/1201/files#r1755891367

@Jovonni this comment by @toliaqat has already been addressed - if you look at the file chainHub section already has two subsections. Let me know if there are any further comments.