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

Update " Your first transaction" tutorial #438

Merged
merged 2 commits into from
Feb 29, 2024
Merged

Conversation

MathieuConte
Copy link
Member

@MathieuConte MathieuConte commented Feb 29, 2024

This PR aims to modify obsolete info and illustrations from the tutorial " Your First Transaction" and enhance some parts


  • Modify 5 illustrations related to nemeton :
    Replace keplr-6 / keplr-8 / keplr-9 / keplr-10 / keplr-12
    by keplrmaj-6 / keplrmaj-8 / keplrmaj-9 / keplrmaj-10 / keplrmaj-12

  • Delete some "$" attached to KNOW due to a policy bug
    know correct

  • Change all the references from nemeton to drunemeton

  • Change Explorer link adresse

  • Enhance readability of some steps with bullet points

Summary by CodeRabbit

  • Documentation
    • Consolidated references to W3C standards in the decentralized identity documentation for improved clarity.
    • Updated the Keplr Wallet tutorial to reflect the latest information on the OKP4 blockchain and $KNOW tokens, enhancing user guidance.

@MathieuConte MathieuConte self-assigned this Feb 29, 2024
Copy link
Contributor

coderabbitai bot commented Feb 29, 2024

Walkthrough

The recent updates aim to streamline documentation on decentralized identity and blockchain tutorials. By consolidating W3C standard references for decentralized identity and refining guidance for using the Keplr Wallet with the OKP4 blockchain, these changes simplify learning for users engaging with decentralized technologies and digital identities.

Changes

File Path Change Summary
docs/.../decentralized-identity.mdx,
docs/tutorials/keplr-1.mdx
Enhanced clarity by consolidating W3C standards and refining tutorial content.
predicates/bech32_address_2.md Updated language declaration to Prolog syntax for a program step.

"In the realm of code, where the rabbits dwell
Changes afoot, in the docs, they swell
📜With W3C in hand, and Keplr by side
Simplifying the complex, with a hop and a stride
🚀To the blockchain, we leap, with KNOW in our grasp
Through digital identities, a future we clasp
🐰So here's to the updates, may clarity reign
In the world of the web, let simplicity gain."

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f3b47cb and c0ca4c2.
Files selected for processing (2)
  • docs/academy/part-2/decentralized-identity.mdx (1 hunks)
  • docs/tutorials/keplr-1.mdx (4 hunks)
Files skipped from review due to trivial changes (1)
  • docs/academy/part-2/decentralized-identity.mdx
Additional comments: 10
docs/tutorials/keplr-1.mdx (10)
  • 39-39: The text correctly updates the reference to the KNOW token, aligning with the PR objective to correct currency symbol usage. However, it's important to ensure that all instances of the token mention throughout the document are consistent and do not include the dollar sign unless specifically intended.
  • 49-49: This step in the tutorial correctly instructs users on how to obtain test tokens, which is crucial for engaging with the OKP4 blockchain. The clarity and accuracy of these instructions are essential for user success. It's important to verify that the link to the official OKP4 faucet is current and operational.
  • 51-51: The illustration update from keplr-6 to keplrmaj-6 is in line with the PR's objective to update outdated illustrations. It's crucial to ensure that the new illustration accurately reflects the current user interface and process of adding the OKP4 network to Keplr. This change enhances the tutorial's relevance and user-friendliness.
  • 57-62: The instructions for making the OKP4-drunemeton-1 network visible within the Keplr extension are clear and straightforward. This step is crucial for users to interact with their $KNOW balance and the OKP4 blockchain. Ensuring that these instructions are up-to-date with the latest version of the Keplr extension is important for maintaining the tutorial's accuracy.
  • 64-64: The illustration update from keplr-8 to keplrmaj-8 aligns with the PR's objective. It's important to verify that the new illustration accurately represents the process described in the text, ensuring that users can easily follow along and make the OKP4 network visible within their Keplr extension.
  • 73-73: The illustration update from keplr-9 to keplrmaj-9 supports the PR's goal of updating outdated illustrations. Ensuring that this illustration accurately reflects the current Keplr interface and the visibility of the $KNOW balance is crucial for user comprehension and engagement with the tutorial.
  • 82-82: Updating the illustration from keplr-10 to keplrmaj-10 is consistent with the PR's objectives. This change is important for demonstrating how users can obtain their OKP4 address, a critical step for receiving and sending $KNOW tokens. Verifying the accuracy of this illustration in relation to the current Keplr interface is essential.
  • 94-94: The update from keplr-12 to keplrmaj-12 for the illustration detailing how to send $KNOW tokens is in line with the PR's aim to refresh outdated visuals. This illustration plays a key role in guiding users through the process of sending tokens, making it imperative that it accurately reflects the current process and interface of the Keplr Wallet.
  • 98-98: The update to the Explorer link address is crucial for ensuring users can verify their transactions on the correct platform. This change aligns with the PR's objective to update references and links. It's important to verify that the provided link directs users to the appropriate OKP4 explorer and that the explorer is operational and reflects the transactions accurately.
  • 110-114: The recap section succinctly summarizes the steps users need to follow to engage with the OKP4 blockchain using Keplr Wallet. This section enhances the tutorial's readability and user-friendliness by providing a clear overview of the process. Ensuring that all steps mentioned are accurate and up-to-date is crucial for user success.

Copy link
Member

@bot-anik bot-anik left a comment

Choose a reason for hiding this comment

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

Device URL
desktop http://localhost:3000/

Device URL
mobile http://localhost:3000/

Not what you expected? Are your scores flaky? GitHub runners could be the cause.
Try running on Foo instead

Copy link
Member

@amimart amimart left a comment

Choose a reason for hiding this comment

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

Thanks 🙏

Copy link
Member

@ccamel ccamel left a comment

Choose a reason for hiding this comment

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

Good! 👍

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c0ca4c2 and f254cb1.
Files selected for processing (1)
  • predicates/bech32_address_2.md (1 hunks)
Additional comments: 1
predicates/bech32_address_2.md (1)
  • 138-138: The change to specify the Prolog syntax for the code block is a good improvement for readability and clarity. It helps tools and readers to correctly interpret the code snippet, especially in documentation that might be viewed in various markdown renderers that support syntax highlighting.

@MathieuConte MathieuConte merged commit 0602cfd into main Feb 29, 2024
12 checks passed
@MathieuConte MathieuConte deleted the feat/modification-tuto branch February 29, 2024 15:11
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.

4 participants