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

General recommendations for improvement of the documentation #34

Open
FidelVe opened this issue May 27, 2022 · 2 comments
Open

General recommendations for improvement of the documentation #34

FidelVe opened this issue May 27, 2022 · 2 comments

Comments

@FidelVe
Copy link
Contributor

FidelVe commented May 27, 2022

After having a conversation with one of the project maintainers about how to improve the overall docs I was recommended to open an issue here with my recommendations to have a more proper way to implement and track the ideas.

My recommendation is to create a section with bite size examples of how to do specific things, im thinking of this like a page with a list of mini tutorials, things like for example:

  • how to query the bnUSD/sICX price on Balanced?
  • how to sign a transaction with ICONex on the client side of a web app?
  • how to get the current goloop version of an API or validator node?

this React page for reference (https://reactjs.org/community/examples.html)

@han-so1omon
Copy link
Contributor

Excellent. I am the one who recommended that you open this issue. Do you have the capacity to write any of these yourself? I would be able to review whatever you write. Otherwise, I will figure out another way for these topics or similar to be written up in the docs.

@FidelVe
Copy link
Contributor Author

FidelVe commented May 31, 2022

yeah I can collaborate writing tutorials is no problem.

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

No branches or pull requests

3 participants
@han-so1omon @FidelVe and others