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(getting-started): local setup with gnodev #1936

Merged
merged 24 commits into from
May 13, 2024

Conversation

leohhhn
Copy link
Contributor

@leohhhn leohhhn commented Apr 16, 2024

Description

This PR introduces a change to the Getting Started section in the docs. As discussed with @moul, it makes sense to have gnodev take the spotlight in the "Local setup" section.

With this PR, I've modified the "Local setup" section to reflect the use of gnodev. I've moved the "Setting up a local chain" & "Premining balances" out of this section, as they will belong better in a new section which will contain new chain initialization flows.

Dep. on #1949

Latest preview: https://www.loom.com/share/a9d354b7234843fb8108f1698cc28b5c?sid=92850b75-5153-4f8b-aa0d-bb9d3aa0d6fd

Contributors' checklist...
  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests
  • Added new benchmarks to generated graphs, if any. More info here.

Copy link

codecov bot commented Apr 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 48.32%. Comparing base (f660be5) to head (573f13d).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1936      +/-   ##
==========================================
+ Coverage   46.63%   48.32%   +1.68%     
==========================================
  Files         492      409      -83     
  Lines       69624    62329    -7295     
==========================================
- Hits        32472    30118    -2354     
+ Misses      34445    29695    -4750     
+ Partials     2707     2516     -191     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Apr 16, 2024
@leohhhn leohhhn marked this pull request as ready for review April 16, 2024 07:30
@leohhhn leohhhn requested review from a team as code owners April 16, 2024 07:30
@leohhhn leohhhn marked this pull request as draft April 16, 2024 07:37
@moul
Copy link
Member

moul commented Apr 27, 2024

Users should focus on testing the language first, setting up language tools, and running node tools at the final step.

Begin with Gno Playground or Gno Studio for the initial tutorial. Proceed to Gnodev and Gnokey for testnets. Finally, include an advanced section for a complete local setup.

The advanced section, for experienced users, could be optional (I suggest not including it for now).

@leohhhn leohhhn marked this pull request as ready for review April 29, 2024 18:27
@leohhhn leohhhn requested a review from gfanton April 30, 2024 07:59
Copy link
Member

@gfanton gfanton left a comment

Choose a reason for hiding this comment

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

nice ! lgtm 👍

@leohhhn leohhhn requested a review from moul as a code owner May 10, 2024 10:41
@leohhhn leohhhn merged commit 98c1d64 into gnolang:master May 13, 2024
6 checks passed
DIGIX666 pushed a commit to kazai777/gno that referenced this pull request May 15, 2024
<!-- please provide a detailed description of the changes made in this
pull request. -->

## Description

This PR introduces a change to the Getting Started section in the docs.
As discussed with @moul, it makes sense to have `gnodev` take the
spotlight in the "Local setup" section.

With this PR, I've modified the "Local setup" section to reflect the use
of `gnodev`. I've moved the "Setting up a local chain" & "Premining
balances" out of this section, as they will belong better in a new
section which will contain new chain initialization flows.

~Dep. on gnolang#1949

Latest preview:
https://www.loom.com/share/a9d354b7234843fb8108f1698cc28b5c?sid=92850b75-5153-4f8b-aa0d-bb9d3aa0d6fd

<details><summary>Contributors' checklist...</summary>

- [x] Added new tests, or not needed, or not feasible
- [x] Provided an example (e.g. screenshot) to aid review or the PR is
self-explanatory
- [x] Updated the official documentation or not needed
- [x] No breaking changes were made, or a `BREAKING CHANGE: xxx` message
was included in the description
- [x] Added references to related issues and PRs
- [ ] Provided any useful hints for running manual tests
- [ ] Added new benchmarks to [generated
graphs](https://gnoland.github.io/benchmarks), if any. More info
[here](https://github.com/gnolang/gno/blob/master/.benchmarks/README.md).
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧾 package/realm Tag used for new Realms or Packages.
Projects
Status: Done
Status: Done
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants