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

Doc devex upgrade #697

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Doc devex upgrade #697

wants to merge 14 commits into from

Conversation

poppyseedDev
Copy link
Contributor

@poppyseedDev poppyseedDev commented Jan 22, 2025

@poppyseedDev poppyseedDev marked this pull request as ready for review January 23, 2025 12:25
@poppyseedDev
Copy link
Contributor Author

@yuxizama the quick start is ready for review :)

@yuxizama
Copy link
Contributor

yuxizama commented Jan 27, 2025

Quick start page

  • Introduce “Standard Confidential ERC-20” early: As a new user, I might not have any prior knowledge of what a "Standard Confidential ERC-20" is. Maybe introduce in this manner:
    - Start with an overview of ERC-20 (basic token standard).
    - Follow with Confidential ERC-20 (its confidential, privacy-preserving variant).
    - Then, explain Confidential ERC-20 Mintable as an extension.

Step 1:

  • Add prerequisites section -> Stay aligned with other pages
  • Remove hyperlink the “Zama plugin in the official Remix IDE” in the introduction sentence to reduce distractions.
  • When installation is complete, include success sign to let users know what happens after clicking "OK".
    "ACL is a valid address.”
    “KMSVerifier is a valid address.”
    “Gateway URL is set.”
  • "Deploy and use contracts after configuring the plugin, you can interact with fhEVM encrypted contracts directly via the Zama plugin interface. "=> Need rewording, clean the headline format.

Step 2:

  • Using metaMask: Add scribe
  • Manual network configuration: the “Currency Symbol” should be SepoliaETH.
  • Balance verification: Clarify how much balance is required to proceed with the tutorial.

Step 3:

  • Remove blanks in code snippets, otherwise it doesn't compile in Remix.
  • Compiling: Include a visual or textual “Success” sign after successful compilation for feedback.
  • Second code snippet: Clarify whether it is a continuation of the previous snippet or a new one.
  • Add “paste code alert” screen: The default Remix warning -> to assure users that they can click "OK"
  • Redeployment clarity: After enhancements, clarify if users need to redeploy their contract or if the original deployment remains sufficient.
  • Provide a link to view the actual contract as a reference. ( As it's only imported in the code)
  • Button naming: Replace "Click Deploy" with “Click Transact” for consistency with the interface.

Step 4:

  • Mint tokens to address: Clarify that users must input their own address (instead of contract address) and sign the transaction in their wallet.
  • Include the success indicator
  • Balance check:
    - Clearly state that users must input their account address to verify the balance.
    - Specify that the result will be encrypted and appear as a encrypted text
    • Explain that “re-encryption" button is actually decrypting the ciphertext
  • Input proof: Add an explanation about the purpose of these steps for better user understanding.

General feedback: The GIFs play too quickly sometimes, making it easy to miss steps. Is it possible to add a play/pause or step-by-step click-through option for better usability?

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