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

Restructure the tutorial #42

Closed
1 task done
outoftardis opened this issue May 5, 2022 · 0 comments · Fixed by #54
Closed
1 task done

Restructure the tutorial #42

outoftardis opened this issue May 5, 2022 · 0 comments · Fixed by #54
Assignees

Comments

@outoftardis
Copy link
Contributor

outoftardis commented May 5, 2022

  • Improve overall tutorial structure without altering the contents of the individual topics.

My notes regarding this:

  1. Some sections should be renamed (e.g., "conclusions"), some information should be moved around and grouped differently presenting the contents of the tutorial in a logical way.

  2. Most of the info in Appendix shouldn't be there at all, because it's not something additional to the tutorial, it's the essential part of the tutorial. This might be a question of renaming the chapter and splitting it in a one or two other chapters.

    • My proposal is to have a "Learn the concepts" type of chapter: e.g. the concept of "genesis block" -- it's mentioned in lang-specific guides, but its only described in appendix and its definition is never referenced from the lang-specific guides. This might not be essential for people already familiar with blockchains but the tutorial is aiming at all kinds of audiences.
    • Config files better be described in something like "Configurations" section.
    • Why is this info https://hyperledger.github.io/iroha-2-docs/guide/appendix/running-iroha-on-bare-metal.html is in the appendix? It's just a more advanced topic than the lang-specific ones, people won't go looking in the appendix for this information.
  3. Address this question: do we think there are a lot of people who are interested in iroha 1 vs. iroha 2 comparison before they learn what this tutorial can offer them? My proposal is to highlight this comparison but not put it at the very beginning.

@outoftardis outoftardis self-assigned this May 5, 2022
outoftardis added a commit to outoftardis/iroha-2-docs that referenced this issue May 23, 2022
Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
outoftardis added a commit to outoftardis/iroha-2-docs that referenced this issue May 23, 2022
Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
outoftardis added a commit that referenced this issue May 24, 2022
* [documentation] #42: Restructure the tutorial

Signed-off-by: Ekaterina Mekhnetsova <mekkatya@gmail.com>
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

Successfully merging a pull request may close this issue.

1 participant