[Substrate.io Migration] Glossary

[CrackTheCode016]

This page is from the substrate.io documentation, and will be heavily edited, updated, and appropriated as needed.

We need a glossary merged (with at least basic terms) so we can link these in other pages.

This includes some terms that may be dated, so we should look to see where to improve or remove.

[CrackTheCode016]

I find a lot of these very unnecessary, this list seems much better IMO: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/glossary/index.html

A lot of these definitions are very specific / quite long, it feels as though we mainly need to cover the following topics in this glossary and throw the rest out:

• FRAME/PSDK specific terms
• Polkadot/Kusama meta specific terms

General blockchain terms, i.e., "Blockchain" in the glossary just seem unnecessary to me, and any outside references should not be in the glossary and instead linked outside to their OG source.

@DrW3RK @eshaben Curious on thoughts here

[DrW3RK]

Okay, I noticed this is not ready for review yet.

I agree that a glossary with concise text is a valuable resource. The text copied in this PR is again quire verbose, which we should work on making it concise.

We could have two sections within the Glossary page, where the first section is purely textual and Polkadot terminology specific and the second section covers the developer terminology in the context of Substrate/FRAME.

[DrW3RK]

One slight change before I start reviewing. Please sort the words in the lexicographically.

[eshaben]

I find a lot of these very unnecessary, this list seems much better IMO: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/glossary/index.html

A lot of these definitions are very specific / quite long, it feels as though we mainly need to cover the following topics in this glossary and throw the rest out:

• FRAME/PSDK specific terms
• Polkadot/Kusama meta specific terms

General blockchain terms, i.e., "Blockchain" in the glossary just seem unnecessary to me, and any outside references should not be in the glossary and instead linked outside to their OG source.

Yeah, I agree. We should only be listing Polkadot-specific terms. The exception to this is possibly Transaction, because it does provide insight to the difference between an extrinsic and transaction. But the other general ones like consensus, finality, etc. I don't think we need

[CrackTheCode016]

@DrW3RK @eshaben removed a good amount of generic stuff, feel free to suggest the removal of anything else. If we feel like we need more definitions, probably better to add them later with their respective PRs as needed.

I augmented / replaced some definitions with some of the more accurate ones from the Polkadot SDK and/or Wiki, and also linked them as other sources. One definition, "sovereign account", is a bit messy, but has some potentially useful content for later so left it as-is.

[eshaben]

Nice! This is great!

I went a bit all out and primarily reviewed for formatting/styling/grammar, but don't be alarmed by the number of comments! Haha. Most of them are link issues or minor grammar issues. The bot we've been working on should help mitigate many of these little things. Other than that, I left comments that should explain why we do certain things. Consistency is key ✨

I noticed some weird formatting of the lines, where some sentences are broken across two lines. Ideally, this would be cleaned up for the next person who has to edit this file.

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

polkadot-protocol/introduction/glossary.md|138 col 196| [Papermoon.CustomDictionary] Did you really mean 'inherents'?
polkadot-protocol/introduction/glossary.md|138 col 196| [Vale.Spelling] Did you really mean 'inherents'?
polkadot-protocol/introduction/glossary.md|140 col 1| [Google.Quotes] Commas and periods go inside quotation marks.
polkadot-protocol/introduction/glossary.md|140 col 9| [Papermoon.Acronyms] Spell out 'SCALE', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|140 col 161| [Vale.Terms] Use 'extrinsics' instead of 'Extrinsics'.
polkadot-protocol/introduction/glossary.md|140 col 190| [Vale.Spelling] Did you really mean 'inherents'?
polkadot-protocol/introduction/glossary.md|140 col 190| [Papermoon.CustomDictionary] Did you really mean 'inherents'?
polkadot-protocol/introduction/glossary.md|146 col 76| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|151 col 125| [Google.Spacing] 'k. A' should have one space.
polkadot-protocol/introduction/glossary.md|153 col 4| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|155 col 271| [Vale.Spelling] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|155 col 271| [Papermoon.CustomDictionary] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|157 col 49| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|168 col 110| [Google.LyHyphens] 'independently-configured' doesn't need a hyphen.
polkadot-protocol/introduction/glossary.md|179 col 143| [Google.LyHyphens] 'minimally-secure' doesn't need a hyphen.
polkadot-protocol/introduction/glossary.md|184 col 65| [Google.LyHyphens] 'loosely-coupled' doesn't need a hyphen.
polkadot-protocol/introduction/glossary.md|201 col 4| [Vale.Terms] Use 'keystore' instead of 'Keystore'.
polkadot-protocol/introduction/glossary.md|205 col 4| [Papermoon.CustomDictionary] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|205 col 4| [Vale.Spelling] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|207 col 2| [Papermoon.CustomDictionary] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|207 col 2| [Vale.Spelling] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|208 col 1| [Papermoon.CustomDictionary] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|208 col 1| [Vale.Spelling] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|208 col 16| [Google.Quotes] Commas and periods go inside quotation marks.
polkadot-protocol/introduction/glossary.md|209 col 22| [Papermoon.CustomDictionary] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|209 col 22| [Vale.Spelling] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|209 col 85| [Papermoon.CustomDictionary] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|209 col 85| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|211 col 22| [Papermoon.CustomDictionary] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|211 col 22| [Vale.Spelling] Did you really mean 'Kusama'?
polkadot-protocol/introduction/glossary.md|220 col 41| [Papermoon.NotContractions] Use 'doesn't' instead of 'does not'.
polkadot-protocol/introduction/glossary.md|247 col 4| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|253 col 60| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|267 col 4| [Vale.Terms] Use 'relay chain' instead of 'Relay Chain'.
polkadot-protocol/introduction/glossary.md|269 col 22| [Vale.Spelling] Did you really mean 'heterogenous'?
polkadot-protocol/introduction/glossary.md|269 col 22| [Papermoon.CustomDictionary] Did you really mean 'heterogenous'?
polkadot-protocol/introduction/glossary.md|270 col 1| [Vale.Terms] Use 'relay chains' instead of 'Relay chains'.
polkadot-protocol/introduction/glossary.md|276 col 5| [Vale.Spelling] Did you really mean 'Rococco'?
polkadot-protocol/introduction/glossary.md|276 col 5| [Papermoon.CustomDictionary] Did you really mean 'Rococco'?
polkadot-protocol/introduction/glossary.md|293 col 90| [Vale.Spelling] Did you really mean 'Sudo'?
polkadot-protocol/introduction/glossary.md|293 col 90| [Papermoon.CustomDictionary] Did you really mean 'Sudo'?
polkadot-protocol/introduction/glossary.md|301 col 114| [Google.Colons] ': S' should be in lowercase.
polkadot-protocol/introduction/glossary.md|308 col 102| [Papermoon.CustomDictionary] Did you really mean 'sibl'?
polkadot-protocol/introduction/glossary.md|308 col 102| [Vale.Spelling] Did you really mean 'sibl'?
polkadot-protocol/introduction/glossary.md|309 col 114| [Google.Colons] ': S' should be in lowercase.
polkadot-protocol/introduction/glossary.md|330 col 2| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|348 col 4| [Papermoon.CustomDictionary] Did you really mean 'Trie'?
polkadot-protocol/introduction/glossary.md|348 col 4| [Vale.Spelling] Did you really mean 'Trie'?
polkadot-protocol/introduction/glossary.md|348 col 19| [Papermoon.CustomDictionary] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|348 col 19| [Vale.Spelling] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|352 col 14| [Vale.Spelling] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|352 col 14| [Papermoon.CustomDictionary] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|352 col 21| [Vale.Spelling] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|352 col 21| [Papermoon.CustomDictionary] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 57| [Papermoon.CustomDictionary] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 57| [Vale.Spelling] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 135| [Google.Spacing] 's. T' should have one space.
polkadot-protocol/introduction/glossary.md|354 col 144| [Vale.Spelling] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 144| [Papermoon.CustomDictionary] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|356 col 4| [Vale.Terms] Use 'validator' instead of 'Validator'.
polkadot-protocol/introduction/glossary.md|366 col 70| [Papermoon.CustomDictionary] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|366 col 70| [Vale.Spelling] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|371 col 45| [Papermoon.CustomDictionary] Did you really mean 'picosecond'?
polkadot-protocol/introduction/glossary.md|371 col 45| [Vale.Spelling] Did you really mean 'picosecond'?
polkadot-protocol/introduction/glossary.md|382 col 4| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|382 col 4| [Papermoon.CustomDictionary] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|384 col 1| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|384 col 1| [Papermoon.CustomDictionary] Did you really mean 'Westend'?

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

polkadot-protocol/introduction/glossary.md|220 col 41| [Papermoon.NotContractions] Use 'doesn't' instead of 'does not'.
polkadot-protocol/introduction/glossary.md|247 col 4| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|253 col 60| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|267 col 4| [Vale.Terms] Use 'relay chain' instead of 'Relay Chain'.
polkadot-protocol/introduction/glossary.md|269 col 22| [Vale.Spelling] Did you really mean 'heterogenous'?
polkadot-protocol/introduction/glossary.md|269 col 22| [Papermoon.CustomDictionary] Did you really mean 'heterogenous'?
polkadot-protocol/introduction/glossary.md|270 col 1| [Vale.Terms] Use 'relay chains' instead of 'Relay chains'.
polkadot-protocol/introduction/glossary.md|276 col 5| [Vale.Spelling] Did you really mean 'Rococco'?
polkadot-protocol/introduction/glossary.md|276 col 5| [Papermoon.CustomDictionary] Did you really mean 'Rococco'?
polkadot-protocol/introduction/glossary.md|293 col 90| [Vale.Spelling] Did you really mean 'Sudo'?
polkadot-protocol/introduction/glossary.md|293 col 90| [Papermoon.CustomDictionary] Did you really mean 'Sudo'?
polkadot-protocol/introduction/glossary.md|301 col 114| [Google.Colons] ': S' should be in lowercase.
polkadot-protocol/introduction/glossary.md|308 col 102| [Vale.Spelling] Did you really mean 'sibl'?
polkadot-protocol/introduction/glossary.md|308 col 102| [Papermoon.CustomDictionary] Did you really mean 'sibl'?
polkadot-protocol/introduction/glossary.md|309 col 114| [Google.Colons] ': S' should be in lowercase.
polkadot-protocol/introduction/glossary.md|330 col 2| [Papermoon.Acronyms] Spell out 'FRAME', if it's unfamiliar to the audience.
polkadot-protocol/introduction/glossary.md|348 col 4| [Vale.Spelling] Did you really mean 'Trie'?
polkadot-protocol/introduction/glossary.md|348 col 4| [Papermoon.CustomDictionary] Did you really mean 'Trie'?
polkadot-protocol/introduction/glossary.md|348 col 19| [Vale.Spelling] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|348 col 19| [Papermoon.CustomDictionary] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|352 col 14| [Vale.Spelling] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|352 col 14| [Papermoon.CustomDictionary] Did you really mean 'Merkle'?
polkadot-protocol/introduction/glossary.md|352 col 21| [Vale.Spelling] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|352 col 21| [Papermoon.CustomDictionary] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 57| [Vale.Spelling] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 57| [Papermoon.CustomDictionary] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 135| [Google.Spacing] 's. T' should have one space.
polkadot-protocol/introduction/glossary.md|354 col 144| [Papermoon.CustomDictionary] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|354 col 144| [Vale.Spelling] Did you really mean 'trie'?
polkadot-protocol/introduction/glossary.md|356 col 4| [Vale.Terms] Use 'validator' instead of 'Validator'.
polkadot-protocol/introduction/glossary.md|366 col 70| [Vale.Spelling] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|366 col 70| [Papermoon.CustomDictionary] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|371 col 45| [Vale.Spelling] Did you really mean 'picosecond'?
polkadot-protocol/introduction/glossary.md|371 col 45| [Papermoon.CustomDictionary] Did you really mean 'picosecond'?
polkadot-protocol/introduction/glossary.md|382 col 4| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|382 col 4| [Papermoon.CustomDictionary] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|384 col 1| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|384 col 1| [Papermoon.CustomDictionary] Did you really mean 'Westend'?

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

polkadot-protocol/introduction/glossary.md|366 col 70| [Papermoon.CustomDictionary] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|366 col 70| [Vale.Spelling] Did you really mean 'runtimes'?
polkadot-protocol/introduction/glossary.md|371 col 45| [Vale.Spelling] Did you really mean 'picosecond'?
polkadot-protocol/introduction/glossary.md|371 col 45| [Papermoon.CustomDictionary] Did you really mean 'picosecond'?
polkadot-protocol/introduction/glossary.md|382 col 4| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|382 col 4| [Papermoon.CustomDictionary] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|384 col 1| [Vale.Spelling] Did you really mean 'Westend'?
polkadot-protocol/introduction/glossary.md|384 col 1| [Papermoon.CustomDictionary] Did you really mean 'Westend'?

[dawnkelly09]

Scan for Vale false positives. Resolved convos = made it on the update list and should go away now. I left comments for the legit flags with suggested edits. Thank you!

[dawnkelly09]

Grammar stuff

[github-actions]

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

polkadot-protocol/introduction/glossary.md|279 col 52| [Papermoon.CustomDictionary] Did you really mean 'blockchain'?
polkadot-protocol/introduction/glossary.md|279 col 129| [Papermoon.CustomDictionary] Did you really mean 'blockchain'?
polkadot-protocol/introduction/glossary.md|284 col 43| [Papermoon.WordSwapList] Use 'Wasm' instead of 'WebAssembly'.
polkadot-protocol/introduction/glossary.md|308 col 16| [Papermoon.CustomDictionary] Did you really mean 'blockchain'?
polkadot-protocol/introduction/glossary.md|318 col 72| [Papermoon.CustomDictionary] Did you really mean 'blockchains'?
polkadot-protocol/introduction/glossary.md|337 col 23| [Papermoon.CustomDictionary] Did you really mean 'blockchains'?
polkadot-protocol/introduction/glossary.md|343 col 4| [Papermoon.WordSwapList] Use 'Wasm' instead of 'WebAssembly'.
polkadot-protocol/introduction/glossary.md|348 col 2| [Papermoon.WordSwapList] Use 'Wasm' instead of 'WebAssembly'.
polkadot-protocol/introduction/glossary.md|351 col 30| [Papermoon.WordSwapList] Use 'Wasm' instead of 'WebAssembly'.
polkadot-protocol/introduction/glossary.md|355 col 38| [Papermoon.CustomDictionary] Did you really mean 'blockchains'?
polkadot-protocol/introduction/glossary.md|369 col 49| [Papermoon.CustomDictionary] Did you really mean 'blockchain'?

[dawnkelly09]

@eshaben This is ready for review for format, etc.

[eshaben]

Thanks! Ran this through Grammarly and quite a few things came up. Aside from my suggestions, please just make sure you go through and update Substrate to Polkadot SDK where it makes sense

[eshaben]

This page is a beast haha. These suggestions just cleans up the broken internal links

You can actually see these printed out in the terminal where you run mkdocs serve:

[eshaben]

LGTM! 🚢