Skip to content

Refactor Sui guide #316

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

Merged
merged 5 commits into from
May 29, 2024
Merged

Refactor Sui guide #316

merged 5 commits into from
May 29, 2024

Conversation

aditya520
Copy link
Member

No description provided.

Copy link

vercel bot commented May 27, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 29, 2024 8:46pm

Copy link
Contributor

@jayantk jayantk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

on the FAQ section, i think the answers to both questions can be inlined in the docs. I don't think this FAQ question corresponds to real questions users asked; I think Leo wrote it by himself anticipating those questions.

I think the "sui rev" question could be a code comment on the Move.toml code snippet. I think the answer can be shortened so that it fits reasonably as a comment

The price object question probably gets inlined as a comment somewhere in the typescript snippet.

const connection = new SuiPriceServiceConnection(
"https://hermes-beta.pyth.network"
); // See Hermes endpoints section below for other endpoints
Pyth provides a javascript SDK to construct transaction blocks that update price feeds.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Pyth also provides

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh also this sentence and the one above should end with a : not a .

@aditya520 aditya520 force-pushed the (chore)-update-sui-guide branch from 07c5506 to c7a0153 Compare May 29, 2024 18:19
@aditya520 aditya520 marked this pull request as ready for review May 29, 2024 18:19

### ⚠️ **_Important Note for Integrators_**
<Callout type="warning" emoji="⚠️">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this callout should come after the code snippet.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is pretty important piece of information, so I believe the callout should be before the code snippet.


### Update Example
The code snippet below provides an example of how to update the Pyth price feeds:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the organization of these code snippets is confusing. Most of our guides have the contract code first, then they don't have the client code at all. In this case, maybe the contract code first, then the client code as a separate section (sort of how we used to have it before?)

Copy link
Member Author

@aditya520 aditya520 May 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, but especially for sui, it is recommended not to update the price from the contract, I believe we keep this flow.

@aditya520 aditya520 merged commit e5eb691 into main May 29, 2024
4 checks passed
@aditya520 aditya520 deleted the (chore)-update-sui-guide branch May 29, 2024 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants