Introduce a common glossary file - #2
Open
karolk91 wants to merge 1 commit into
Open
Conversation
| storage, calls, events and errors. A runtime is composed of pallets | ||
| (`pallet-balances`, `pallet-staking`, …). | ||
|
|
||
| **Runtime API** — A versioned interface (`sp-api`) the Wasm runtime exposes |
| **System chain** — A parachain that is part of the network's protocol itself. | ||
| Runs on behalf of the network; its runtime lives in the *Fellowship | ||
| runtimes*. Uses a para ID below 2000 — the range that is not publicly | ||
| registrable (`LOWEST_PUBLIC_ID` in polkadot-sdk). |
There was a problem hiding this comment.
also here link would be nice.
I think we should cross-link whenever possible (fixed commit not master).
bkchr
reviewed
Aug 24, 2026
bkchr
left a comment
bkchr
left a comment
Member
There was a problem hiding this comment.
Please make them more "on the point". E.g. "node" is repeating itself and tries to convey too much information that is totally unneeded "The binary running a chain: networking, database, consensus, RPC." is more than enough to get you started.
| gated by an authorization model — | ||
| an account is authorized in advance to upload, and authorizations expire. | ||
| Data is uploaded by submitting extrinsics; the uploaded data itself is kept | ||
| in off-chain storage, not in the runtime state, and has a retention period. |
Contributor
There was a problem hiding this comment.
It's not kept in runtime state but it is kept by all collators. Important distinction to Web3 Storage where collators wouldn't keep any of the data
| validation, metadata, …). Not the node's JSON-RPC: RPC is served by the node | ||
| to external clients, a runtime API is called by the node into the runtime. | ||
|
|
||
| **SDK release** — A versioned release (`stableYYMM`) of |
Contributor
There was a problem hiding this comment.
There are also patch releases
Comment on lines
+22
to
+23
| **Fellowship runtimes** — The production runtimes of Polkadot, Kusama and | ||
| their *system chains*, maintained by the Polkadot Technical Fellowship in |
There was a problem hiding this comment.
Suggested change
| **Fellowship runtimes** — The production runtimes of Polkadot, Kusama and | |
| their *system chains*, maintained by the Polkadot Technical Fellowship in | |
| **Fellowship runtimes** — The production runtimes of Polkadot and Kusama, maintained by the Polkadot Technical Fellowship in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The PR proposes a place for common terminology, dictionary-style. Technical docs should strive to use common nomenclature to reduce ambiguity - ideally could be AI-friendly to provide a quality context for AI-assisted research
File is named GLOSSARY.md and placed at the root of the repo but its just the initial idea - opening this PR with some examples for discussion