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

Introduction for Novices #97

Open
prototypo opened this issue Mar 3, 2023 · 1 comment
Open

Introduction for Novices #97

prototypo opened this issue Mar 3, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@prototypo
Copy link
Collaborator

The Introduction begins with an assumption that the reader is already familiar with blockchain-speak (e.g., layer one vs. layer two). This makes it challenging for new readers who will then need to stop reading and search for those terms. There are several ways to change this. For example:

  • Soften the introduction to explain all relevant terms; or
  • Provide hyperlinks to explanations (i.e., to 101blockchains.com, Binance Academy, or some similar site with high SEO).

If the community can express a preference, I am willing to do this work.

@prototypo prototypo added the documentation Improvements or additions to documentation label Mar 3, 2023
@prototypo prototypo self-assigned this Mar 3, 2023
@ermyas
Copy link
Collaborator

ermyas commented Mar 3, 2023

Thanks for the feedback @prototypo
You are right. While the introduction offers links to some terms (e.g. "modular blockchains"), it does assume that the reader is familiar with more common terms like "layer one". I think adding links to those is a great idea. We can also consider whether we want to have a glossary page.

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
None yet
Development

No branches or pull requests

2 participants