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: fix outdated documentation in r/demo/boards #1019

Merged
merged 2 commits into from
Aug 3, 2023

Conversation

gfanton
Copy link
Member

@gfanton gfanton commented Aug 2, 2023

corrects outdated documentation in examples/gno.land/r/demo/boards/README.md:

  • The previous address gno.land:36657 was replaced with the working address test3.gno.land:36657 as the former is no longer functional.
  • The previous package path gno.land/r/boards was replaced with the new path gno.land/r/demo/boards

This change ensures that users following the instructions in the README will be able to successfully connect to gnoland node using the correct address, avoiding potential issues related to using an outdated address.

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.

Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>
@gfanton gfanton self-assigned this Aug 2, 2023
@gfanton gfanton requested a review from a team as a code owner August 2, 2023 15:14
@github-actions github-actions bot added the 🧾 package/realm Tag used for new Realms or Packages. label Aug 2, 2023
@moul moul added the 📖 documentation Improvements or additions to documentation label Aug 2, 2023
@harry-hov harry-hov self-requested a review August 2, 2023 18:25
Signed-off-by: gfanton <8671905+gfanton@users.noreply.github.com>
@gfanton
Copy link
Member Author

gfanton commented Aug 3, 2023

@harry-hov updated ! thanks !

@harry-hov
Copy link
Contributor

Wow. That was quick. Thanks, @gfanton! :shipit:

@harry-hov
Copy link
Contributor

I'm just nitpicking. Can you modify the PR title to match the changes -

Maybe? fix(doc): update broken paths and link in r/demo/boards

Or something better.

@moul
Copy link
Member

moul commented Aug 3, 2023

docs: fix outdated documentation in r/demo/boards

Even better: Use 'docs' instead of 'fix' in the commit message, and clarify the change made for the end-user, not just the contribution. See https://www.conventionalcommits.org/en/v1.0.0/ and https://github.com/semantic-release/semantic-release for details.

@gfanton gfanton changed the title fix(doc): replace wrong gno.land address with test3.gno.land docs: fix outdated documentation in r/demo/boards Aug 3, 2023
@gfanton
Copy link
Member Author

gfanton commented Aug 3, 2023

@moul @harry-hov make sense! i've updated the title and the body of the PR as requested!

@moul moul merged commit ce2daf4 into gnolang:master Aug 3, 2023
8 checks passed
Doozers pushed a commit to Doozers/gno that referenced this pull request Aug 31, 2023
@moul moul added this to the 🌟 main.gno.land (wanted) milestone Sep 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation 🧾 package/realm Tag used for new Realms or Packages.
Projects
Archived in project
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants