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

Some READMEs refer to an old version of the quickstart guide #1031

Closed
D4ryl00 opened this issue Aug 7, 2023 · 3 comments · Fixed by #1049
Closed

Some READMEs refer to an old version of the quickstart guide #1031

D4ryl00 opened this issue Aug 7, 2023 · 3 comments · Fixed by #1049
Labels
📖 documentation Improvements or additions to documentation

Comments

@D4ryl00
Copy link
Contributor

D4ryl00 commented Aug 7, 2023

Description

The two READMEs:

refer to the quickstart guide on the blockchain: https://test2.gno.land/r/boards:testboard/5
which is outdated from the latest version: https://github.com/gnolang/gno/blob/master/examples/gno.land/r/demo/boards/README.md

I suggest the quickstart guide point to the GitHub version instead of the blockchain version to avoid new users wasting their time to understand why that doesn't work as expected.

Are there things I don't know that you prefer to keep to the blockchain version?

@D4ryl00
Copy link
Contributor Author

D4ryl00 commented Aug 8, 2023

Or you can automatically update the board with a CI's job when the README changes. In the meantime, let's use this Github's README instead.

@moul
Copy link
Member

moul commented Aug 10, 2023

The project is changing, and quickstart guides can become outdated.

Let's establish the official guide on GitHub and update onchain guide to link to GitHub.

Later, we can consider reverting to an onchain-first approach.

cc @gnolang/devrels

@moul moul added the 📖 documentation Improvements or additions to documentation label Aug 10, 2023
@D4ryl00
Copy link
Contributor Author

D4ryl00 commented Aug 10, 2023

Ok, we can open a PR on that repo to change that.

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
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants