diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
index a5e7c4d7cf6f..c0a396147dd0 100644
--- a/.github/ISSUE_TEMPLATE/feature-request.md
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -3,8 +3,7 @@ name: Feature Request
about: Suggest an idea for the Wiki
title: "[Feature Request]"
labels: docs
-assignees: ''
-
+assignees: ""
---
**Is your feature request related to a problem? Please describe.**
diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml
index 8f43ffe414d0..27df516f78ec 100644
--- a/.github/workflows/codeql-analysis.yml
+++ b/.github/workflows/codeql-analysis.yml
@@ -13,12 +13,12 @@ name: "CodeQL"
on:
push:
- branches: [ master ]
+ branches: [master]
pull_request:
# The branches below must be a subset of the branches above
- branches: [ master ]
+ branches: [master]
schedule:
- - cron: '19 9 * * 2'
+ - cron: "19 9 * * 2"
jobs:
analyze:
@@ -32,40 +32,40 @@ jobs:
strategy:
fail-fast: false
matrix:
- language: [ 'javascript' ]
+ language: ["javascript"]
# CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
# Learn more:
# https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
steps:
- - name: Checkout repository
- uses: actions/checkout@v2
+ - name: Checkout repository
+ uses: actions/checkout@v2
- # Initializes the CodeQL tools for scanning.
- - name: Initialize CodeQL
- uses: github/codeql-action/init@v1
- with:
- languages: ${{ matrix.language }}
- # If you wish to specify custom queries, you can do so here or in a config file.
- # By default, queries listed here will override any specified in a config file.
- # Prefix the list here with "+" to use these queries and those in the config file.
- # queries: ./path/to/local/query, your-org/your-repo/queries@main
+ # Initializes the CodeQL tools for scanning.
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v1
+ with:
+ languages: ${{ matrix.language }}
+ # If you wish to specify custom queries, you can do so here or in a config file.
+ # By default, queries listed here will override any specified in a config file.
+ # Prefix the list here with "+" to use these queries and those in the config file.
+ # queries: ./path/to/local/query, your-org/your-repo/queries@main
- # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
- # If this step fails, then you should remove it and run the build manually (see below)
- - name: Autobuild
- uses: github/codeql-action/autobuild@v1
+ # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
+ # If this step fails, then you should remove it and run the build manually (see below)
+ - name: Autobuild
+ uses: github/codeql-action/autobuild@v1
- # ℹ️ Command-line programs to run using the OS shell.
- # 📚 https://git.io/JvXDl
+ # ℹ️ Command-line programs to run using the OS shell.
+ # 📚 https://git.io/JvXDl
- # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
- # and modify them (or add more) to build your code if your project
- # uses a compiled language
+ # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+ # and modify them (or add more) to build your code if your project
+ # uses a compiled language
- #- run: |
- # make bootstrap
- # make release
+ #- run: |
+ # make bootstrap
+ # make release
- - name: Perform CodeQL Analysis
- uses: github/codeql-action/analyze@v1
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v1
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
index b0d0bced9be2..e6a1514db62e 100644
--- a/CODE_OF_CONDUCT.md
+++ b/CODE_OF_CONDUCT.md
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
Examples of behavior that contributes to a positive environment for our
community include:
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
+- Focusing on what is best not just for us as individuals, but for the
overall community
Examples of unacceptable behavior include:
-* The use of sexualized language or imagery, and sexual attention or
+- The use of sexualized language or imagery, and sexual attention or
advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
### 4. Permanent Ban
**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
+standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within
diff --git a/README.md b/README.md
index e26a5f9fd826..6d5836a56af1 100644
--- a/README.md
+++ b/README.md
@@ -112,7 +112,6 @@ The servers will reflect the latest `master` commit or PR put up against the mas
The latest version of `master` is staged and checked by the team. If all is well, the new commits on `master` are transferred into the production branch,`prod`, by rebasing `master` on `prod`. The CICD production workflow will deploy `prod` to the public sites:
[Polkadot Wiki](https://wiki.polkadot.network) and [Kusama Guide](https://guide.kusama.network), respectively.
-
### Mirror Pages
A limitation of Docusaurus is that pages can only be included in one sidebar at any given time.
diff --git a/docs/assets/guides/polkadot-guide/Account.png b/docs/assets/guides/polkadot-guide/Account.png
new file mode 100644
index 000000000000..a7380337c997
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Account.png differ
diff --git a/docs/assets/guides/polkadot-guide/Ambassadors.png b/docs/assets/guides/polkadot-guide/Ambassadors.png
new file mode 100644
index 000000000000..b3f95dc79540
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Ambassadors.png differ
diff --git a/docs/assets/guides/polkadot-guide/Bridges.png b/docs/assets/guides/polkadot-guide/Bridges.png
new file mode 100644
index 000000000000..6e283c6b730d
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Bridges.png differ
diff --git a/docs/assets/guides/polkadot-guide/Council.png b/docs/assets/guides/polkadot-guide/Council.png
new file mode 100644
index 000000000000..f21272860464
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Council.png differ
diff --git a/docs/assets/guides/polkadot-guide/Identity.png b/docs/assets/guides/polkadot-guide/Identity.png
new file mode 100644
index 000000000000..6ff80e56ffd3
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Identity.png differ
diff --git a/docs/assets/guides/polkadot-guide/Kusama.svg b/docs/assets/guides/polkadot-guide/Kusama.svg
new file mode 100644
index 000000000000..89e1c399d96e
--- /dev/null
+++ b/docs/assets/guides/polkadot-guide/Kusama.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/assets/guides/polkadot-guide/Network.png b/docs/assets/guides/polkadot-guide/Network.png
new file mode 100644
index 000000000000..f19bda2e978a
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Network.png differ
diff --git a/docs/assets/guides/polkadot-guide/Parachain.png b/docs/assets/guides/polkadot-guide/Parachain.png
new file mode 100644
index 000000000000..1f124e66f098
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Parachain.png differ
diff --git a/docs/assets/guides/polkadot-guide/Proposal.png b/docs/assets/guides/polkadot-guide/Proposal.png
new file mode 100644
index 000000000000..a224542a7042
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Proposal.png differ
diff --git a/docs/assets/guides/polkadot-guide/Proxy.png b/docs/assets/guides/polkadot-guide/Proxy.png
new file mode 100644
index 000000000000..a9ce0a97d9c0
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Proxy.png differ
diff --git a/docs/assets/guides/polkadot-guide/Stake.png b/docs/assets/guides/polkadot-guide/Stake.png
new file mode 100644
index 000000000000..866440650a0d
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Stake.png differ
diff --git a/docs/assets/guides/polkadot-guide/Transfer.png b/docs/assets/guides/polkadot-guide/Transfer.png
new file mode 100644
index 000000000000..2eed9d377dbb
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Transfer.png differ
diff --git a/docs/assets/guides/polkadot-guide/Treasury.png b/docs/assets/guides/polkadot-guide/Treasury.png
new file mode 100644
index 000000000000..119101b10dae
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Treasury.png differ
diff --git a/docs/assets/guides/polkadot-guide/Voting.png b/docs/assets/guides/polkadot-guide/Voting.png
new file mode 100644
index 000000000000..ee79dcf086d2
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/Voting.png differ
diff --git a/docs/assets/guides/polkadot-guide/kusama.png b/docs/assets/guides/polkadot-guide/kusama.png
new file mode 100644
index 000000000000..07105c445fe7
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/kusama.png differ
diff --git a/docs/assets/guides/polkadot-guide/network.jpeg b/docs/assets/guides/polkadot-guide/network.jpeg
new file mode 100644
index 000000000000..62f9b74cfc4d
Binary files /dev/null and b/docs/assets/guides/polkadot-guide/network.jpeg differ
diff --git a/docs/build/build-node-interaction.md b/docs/build/build-node-interaction.md
index bb450f8e8b70..5ae08289a707 100644
--- a/docs/build/build-node-interaction.md
+++ b/docs/build/build-node-interaction.md
@@ -16,7 +16,6 @@ documentation for the tool you are using:
**Polkadot-JS RPC** is a JavaScript library for interacting with the **Substrate RPC API** endpoint, distributed as `@polkadot/api` Node.js package.
**Substrate API Sidecar** is using the **Polkadot-JS RPC** to provide separately runnable REST services.
-
## Polkadot RPC
The Parity Polkadot client exposes HTTP and WS endpoints for RPC connections. The default ports are
diff --git a/docs/build/build-wallets.md b/docs/build/build-wallets.md
index 5a8d236b383d..9b689c3ae931 100644
--- a/docs/build/build-wallets.md
+++ b/docs/build/build-wallets.md
@@ -33,12 +33,12 @@ contact the developers of that wallet.
These are wallets which have been supported by either the Polkadot or Kusama Treasury via Treasury Proposal. Links in the Proposals section go to the Polkassembly post where the Treasury Proposal was discussed.
-| Wallet Name | Proposals | Development State | Team Name | Description | Custody | Supports |
-| --------------------------------------------- | ------------------------------------------------- | ----------------- | -------------- | ------------ | ------------- | -------- |
-| [Fearless Wallet](https://fearlesswallet.io/) | [1](https://kusama.polkassembly.io/treasury/23), [2](https://kusama.polkassembly.io/treasury/34), [3](https://kusama.polkassembly.io/treasury/74), [4](https://kusama.polkassembly.io/treasury/102) | Live | SORAMITSU | iOS, Android | Non-custodial | Staking |
-| [Klever](https://klever.io/) | [1](https://kusama.polkassembly.io/treasury/91) | Live | Klever | iOS, Android | Non-custodial | Staking |
-| [Polkawallet](https://polkawallet.io/) | [1](https://kusama.polkassembly.io/treasury/32), [2](https://kusama.polkassembly.io/treasury/41) | Live | Polkawallet | iOS, Android | Non-custodial | Staking |
-| [Stylo](https://stylo-app.com/) | [1](https://polkadot.polkassembly.io/treasury/39) | Live | Thibaut Sardan | Android | Non-custodial | Staking |
+| Wallet Name | Proposals | Development State | Team Name | Description | Custody | Supports |
+| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | -------------- | ------------ | ------------- | -------- |
+| [Fearless Wallet](https://fearlesswallet.io/) | [1](https://kusama.polkassembly.io/treasury/23), [2](https://kusama.polkassembly.io/treasury/34), [3](https://kusama.polkassembly.io/treasury/74), [4](https://kusama.polkassembly.io/treasury/102) | Live | SORAMITSU | iOS, Android | Non-custodial | Staking |
+| [Klever](https://klever.io/) | [1](https://kusama.polkassembly.io/treasury/91) | Live | Klever | iOS, Android | Non-custodial | Staking |
+| [Polkawallet](https://polkawallet.io/) | [1](https://kusama.polkassembly.io/treasury/32), [2](https://kusama.polkassembly.io/treasury/41) | Live | Polkawallet | iOS, Android | Non-custodial | Staking |
+| [Stylo](https://stylo-app.com/) | [1](https://polkadot.polkassembly.io/treasury/39) | Live | Thibaut Sardan | Android | Non-custodial | Staking |
> NOTE: these third-party wallets have been funded by the community through either the Polkadot or Kusama [Treasury](learn-treasury). **Web 3.0 Technologies Foundation does not endorse these wallets, and you should use your own due diligence in researching them.** The official Polkadot Support cannot provide support for issues with these wallets or other non-Parity developed wallets.
diff --git a/docs/general/faq.md b/docs/general/faq.md
index 0beb893ca828..fcd28996cf8e 100644
--- a/docs/general/faq.md
+++ b/docs/general/faq.md
@@ -40,7 +40,7 @@ For more information on the Polkadot roadmap please visit the
### How do I apply to be a validator?
-There is no central authority that decides on validators, so there is not per se an *application*
+There is no central authority that decides on validators, so there is not per se an _application_
that you can fill out. Registering as a validator is permissionless; in order to become one you must
only set up a validator node and mark your intention to validate on chain. For detailed instruction
on how to do this you can consult the
@@ -48,13 +48,13 @@ on how to do this you can consult the
[Polkadot validator guide](../maintain/maintain-guides-how-to-validate-polkadot.md) for validating on Polkadot.
However, once you've set up a validator and have registered your intention it does not mean that you
-will be included in the *active set* right away. The validators are elected to the active set based
+will be included in the _active set_ right away. The validators are elected to the active set based
on the results of an election algorithm known as [Phragmén's method](../learn/learn-phragmen.md). Phragmén's
method tries to accomplish two goals: 1) select `n` members from a larger set based on
stake-weighted votes and 2) equalize the stake backing each validator as much as possible.
You will likely want to campaign your validator to the community in order to get more backing. You
-are looking for *nominators* that will put up their tokens to increase the stake for your validator.
+are looking for _nominators_ that will put up their tokens to increase the stake for your validator.
For validators who cannot acquire the minimum stake from the community, Parity and Web3 Foundation
also run a joint program called [Thousand Validators](thousand-validators.md) that will nominate
validators if they apply and fit the requirements.
@@ -104,7 +104,7 @@ similar PoS chains with comparable levels of economic security as Polkadot. The
are operating with around 150 validators, while Polkadot is already securely running with
{{ num_validators }}.
-Additionally, other projects sometimes have a different definition of *validator* that approximates
+Additionally, other projects sometimes have a different definition of _validator_ that approximates
more closely to remote signing keys without the full operation of a validating node. On Polkadot,
each validator is running their own validating node and performing full verification of the Relay
Chain, voting on finality, producing blocks in their decided slots, and verifying parachain state
@@ -131,13 +131,13 @@ No - and yes. The Polkadot Relay Chain does not implement smart contracts native
not having smart contracts on the Relay Chain is part of the design philosophy for Polkadot that
dictates that the Relay Chain should be the minimal logic required to accomplish its job.
-However, Polkadot will be a platform for other chains that *do* implement smart contracts. It's
+However, Polkadot will be a platform for other chains that _do_ implement smart contracts. It's
possible for parachains to enable smart contract functionality and then benefit from the security
and interoperability features of Polkadot. Additionally, existing smart contract chains can connect
to Polkadot as a parachain, or via a bridge.
While the Polkadot Relay Chain does not implement smart contracts directly, undoubtedly there will
-be parachains that do. So it's better to say that the Polkadot *ecosystem* has smart contracts
+be parachains that do. So it's better to say that the Polkadot _ecosystem_ has smart contracts
versus "Polkadot has smart contracts."
### How will the Polkadot Relay Chain connect to external chains in the ecosystem?
@@ -189,13 +189,13 @@ conviction to sway the progression of the protocol.
A savvy reader might have noticed that the answer to the previous question endowed the token holder
with the ultimate responsibility to ensure that Polkadot's governance does not fail. By following
the train of this assertion, one might assume that Polkadot's governance is susceptible to becoming
-ruled by a few large token holders (called *whales* in trading parlance) and therefore become a mere
+ruled by a few large token holders (called _whales_ in trading parlance) and therefore become a mere
plutocracy (rule of the rich).
There are several other mechanisms that are built-in to the governance system to resist this
plutocratic tendency. One of these mechanisms is called conviction voting, and imbues greater voting
power to token holders who are willing to lock their tokens on the protocol for longer lengths of
-time. Longer lock-ups display *conviction* in a vote. Conviction voting could allow a highly
+time. Longer lock-ups display _conviction_ in a vote. Conviction voting could allow a highly
determined minority to overrule the vote of an apathetic majority in certain situations. Another
mechanism is known as Adaptive Quorum Biasing. This makes proposals have a varying threshold for
approval or rejection based on what part of the governance protocol the proposal originated in. For
diff --git a/docs/general/getting-started.md b/docs/general/getting-started.md
index 3f513dd372c4..0a2b07d6e383 100644
--- a/docs/general/getting-started.md
+++ b/docs/general/getting-started.md
@@ -87,7 +87,7 @@ Whether you're a blockchain developer or if you're interested in taking part of
platform for everyone. This wiki offers a place for builders and maintainers to utilize
[tools](../build/build-tools-index.md) and for brand-new learners to dive into educational material.
-## Getting Started
+# Getting Started
For brand-new learners of Blockchain technology:
@@ -97,7 +97,7 @@ For brand-new learners of Blockchain technology:
This is recommended for users with backgrounds of all levels, and the course is free!
-### For brand-new learners of Polkadot:
+## Brand-New Polkadot learners:
- [Polkadot's original white paper][white-paper] is a technical summary around one possible
direction of implementing the Polkadot network. This paper uses rationale and technical details to
@@ -119,18 +119,123 @@ This is recommended for users with backgrounds of all levels, and the course is
- Reading [What is Polkadot? A Brief Introduction][article] on Medium. There are also other great
articles to read on [Polkadot's Medium][p medium] or [Web3 Foundation's Medium][w medium].
- #### To start interacting with Polkadot:
-
- - [Creating a Polkadot Account][account generation]
- - [Sending a Balance transfer][transfer]
- - [Staking as Nominator][nominator]
- - [Running a Validator][validator]
- - [Setting an Identity][identity]
- - [Creating a Proxy Account][proxy]
- - [Making Proposals and Voting for Referenda][democracy]
- - [Running for the Council][council]
- - [Voting for Councillors][council voting]
- - [Using the Treasury][treasury]
+### Interact with Polkadot
+
+
+
+
For brand-new learners of Kusama, Polkadot's canary cousin network: To learn more about how to build
and maintain on the Kusama network, please head over to our [Kusama Guide][kusama guide].
@@ -180,3 +285,7 @@ and maintain on the Kusama network, please head over to our [Kusama Guide][kusam
[council voting]: ../maintain/maintain-guides-how-to-vote-councillor.md
[treasury]: ../learn/learn-treasury.md
[kusama guide]: https://guide.kusama.network/
+[1]: ../learn/account-generation.md
+
+[2]:
+[3]:
diff --git a/docs/general/kusama/kusama-getting-started.md b/docs/general/kusama/kusama-getting-started.md
index 06a4a353c103..481047af8700 100644
--- a/docs/general/kusama/kusama-getting-started.md
+++ b/docs/general/kusama/kusama-getting-started.md
@@ -16,6 +16,124 @@ For brand-new learners of Blockchain technology:
This is recommended for users with backgrounds of all levels, and the course is free!
+### Interact with Kusama
+
+