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

Create a DApp Tutorial #612

Merged
merged 21 commits into from
May 10, 2023
Merged

Create a DApp Tutorial #612

merged 21 commits into from
May 10, 2023

Conversation

jboetticher
Copy link
Contributor

Description

A beginner tutorial that helps someone learn the components of every DApp. Might need a change in the section with private keys

Checklist

  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If this page requires a disclaimer, I have added one

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Another thorough tutorial! Nice job!

Some thoughts:

  • The index page icon is missing for the tutorial
  • I think for SEO purposes, it would be beneficial to rename the tutorial "How to Build a DApp" - what are your thoughts?
  • I didn't do the full grammar check yet but I can do that after some initial changes are made
  • This guide could benefit from diagrams of the architecture (made a comment about where to find some)
  • New feature: expandable code snippets that I think could come in handy here ✨
  • As mentioned in one of my comments, I think this guide would be better suited to be a code-oriented tutorial on architecture rather than a thought process/overview. I'll get back to you on the Web2 vs Web3 blogpost as this is quite similar where they both cover architecture

tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
tutorials/eth-api/complete-dapp-architecture.md Outdated Show resolved Hide resolved
@jboetticher jboetticher requested a review from eshaben May 3, 2023 20:01
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Sweeeet! Went through and made some grammar and formatting changes. Two major changes made were. The first being to the expandable snippets so they act as recaps of the files as code is added to them (to help avoid confusion). The second is that I also moved some of the content (i.e., setting up the ABI), so that the content is covered right before it is used (i.e., the ABI is used in the read smart contract data section)

Well done! This is a great addition to the docs site! 💜 🎉

@eshaben eshaben merged commit b9d5e40 into master May 10, 2023
1 check passed
@eshaben eshaben deleted the j2-dapp-tutorial branch May 10, 2023 01:42
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.

None yet

3 participants