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

docs: Modify Hello world tutorial #3768

Merged
merged 10 commits into from
Nov 24, 2023
Merged

docs: Modify Hello world tutorial #3768

merged 10 commits into from
Nov 24, 2023

Conversation

toschdev
Copy link
Contributor

The Hello World tutorial was explaining way too many details to be a "short entry" into building your first blockchain.

This PR aims to make it very easy to follow and really quick to go through, for developers to see how easy it is to get their first chain running.

Copy link
Contributor

github-actions bot commented Nov 22, 2023

Visit the preview URL for this PR (updated for commit 2cca263):

https://igntservices-docs--pr3768-docs-hello-world-47u6csdw.web.app

(expires Fri, 01 Dec 2023 19:04:14 GMT)

🔥 via Firebase Hosting GitHub Action 🌎

Sign: 95379efd94dd497aaa37c2d0354e6e2cafca5ec5

@toschdev toschdev marked this pull request as ready for review November 22, 2023 11:51
@toschdev toschdev added the skip-changelog Don't check changelog for new entries label Nov 22, 2023
@toschdev toschdev enabled auto-merge (squash) November 22, 2023 12:00
Copy link
Member

@salmad3 salmad3 left a comment

Choose a reason for hiding this comment

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

Thanks @toschdev, real clean! I left some suggestions.
Tested e2e and lgtm.

I also believe the extra context provided in the original tutorial are beneficial for individuals seeking a deeper understanding of each component. To accommodate this, we could consider integrating a condensed version of these explanations as dropdown menu(s) for those seeking further information, in a way where it doesn't overwhelm the tutorial itself. We could also present brief notes as markdown comments for straightforward reference instead of drop downs, or a combination of both.

If not, I'd advocate for a reference existing somewhere, and then in a single statement, we can point to the reference by stating something like "if you're interested in more details about xyz, go here." This probably works best for the "hello world" tutorial.

docs/docs/02-guide/03-hello-world.md Outdated Show resolved Hide resolved
docs/docs/02-guide/03-hello-world.md Outdated Show resolved Hide resolved
docs/docs/02-guide/03-hello-world.md Show resolved Hide resolved
docs/docs/02-guide/03-hello-world.md Show resolved Hide resolved
docs/docs/02-guide/03-hello-world.md Show resolved Hide resolved
@toschdev toschdev requested a review from salmad3 November 23, 2023 09:51
@ilgooz ilgooz disabled auto-merge November 24, 2023 22:38
@ilgooz ilgooz merged commit 752382c into main Nov 24, 2023
26 checks passed
@ilgooz ilgooz deleted the docs/hello-world branch November 24, 2023 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog Don't check changelog for new entries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants