-
Notifications
You must be signed in to change notification settings - Fork 11.3k
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
Address docs TODOs #732
Comments
Next, see Francois's comments in: |
Another set of TODOs, from our Contributing page, currently at the following addess but moving to doc/src/contribute/index.md: TODO: Define basic system requirements for a reliable environment: recommended OS and required packages. TODO: Note the git clone command above may fail with the following error, which should go away when we open our repo up: TODO: Add links to the (Pull requests) steps above for more details, such as how to build and test the dev site and where to find the CLA once we have one. |
Move all TODOs and broken links to issue 732: #732
From: Pulled these TODO links: |
From: EDITORIAL NOTE: A diagram would be useful here. Can we use Mermaid as now seen in the Summary thanks to Evan? Tracked in: EDITORIAL NOTE: Should we describe how to audit this here? In a separate section? |
Move editorial notes from Objects to issue 732: #732
From: TODO: Explain how this page will be used and by whom. |
Move TODOs from SuiJSON to issue 732: #732
Move TODOs and editorial comments to issue 732: #732
From: TODO: Define Gas and settle upon spelling and capitalization right here. And fix all broken links here. EDITORIAL NOTE: today's transfer sends the input object instead of debiting it + creating/transferring a new object. But that seems inconvenient because a user will not typically have an object with exactly the intended value. This means the typical "send money" flow will be two txes: (1) split an existing coin object to get a fresh one with the desired value, then (2) send the fresh coin. I think we should change transfer to work in the way described here, which combines this into a single transaction. I think we will still want a transfer that works like the current one as well, but I think it should operate on (e.g.) nonfungible token types instead once we have a standard for those, and should support sending multiple tokens to multiple recipients in a single transaction. EDITORIAL NOTE: this does not exist yet, but I think it should TODO: Either add to the list of one above or combine with the intro sentence as one paragraph (includes Inputs...). |
In About Sui, Evan expressed concern about claims made. See: |
Move TODOs from SuiJSON to issue 732: #732
Move TODOs and editorial comments to issue 732: #732
Move all TODOs and broken links to issue 732: #732
Move editorial notes from Objects to issue 732: #732
Alberto rightfully suggests we develop some diagrams to depict our user flow from sender through certificate, both common and advanced, in How Sui Works. |
Arun, Adam, Sam and others have valuable input in the original REST Server doc we should consider for improvement: |
From: TODO: Link to guidance for how we want this done. Something generic resembling: TODO: Find out if we need the "%2F" URL at the end. Also, can we include the URL without character substitution? TODO: Remove or populate the "no more about running locally" header. |
Move TODOs to PR 732 for tracking: #732
From: TODO: Explain the purpose of the client and relationship to the Sui Explorer described in the following page, linking between the two at the top: TODO: Make link to this section: Please consult section Serving Apps with Client-Side Routing. |
From: TODO: see if keys need to be scoped by contexts Observability of MOVE programs, events, etc. We need to provide means to authenticate the events etc (by linking them to signed effects). TODO: Add instructions for setting env var and building Sui specially to enable Tokio-console support. |
Remove TODOs and blank sections Add TODOs to doc bug for tracking: #732
Remove TODOs and blank sections Add TODOs to doc bug for tracking: #732
This bug will capture open TODOs from the docs.
From our central README:
*To understand what's possible by browsing examples of full-fledged applications and games built on top of Sui, review the Demos
Move quick start
Then deeper: Sui standard library, design patterns, examples.
Wallet quick start
Then deeper: wallet CLI vs client service vs forwarder architecture, how to integrate your code (wallet, indexer, ...) with the client service or forwarder components.
The text was updated successfully, but these errors were encountered: