Skip to content

Commit

Permalink
unify url formatting (w3f#4210)
Browse files Browse the repository at this point in the history
  • Loading branch information
alfarok authored Dec 21, 2022
1 parent f58b210 commit 5dc3494
Show file tree
Hide file tree
Showing 28 changed files with 434 additions and 459 deletions.
5 changes: 2 additions & 3 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,14 +100,13 @@ of classes of individuals.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at
This Code of Conduct is adapted from the
[Contributor Covenant](https://www.contributor-covenant.org), version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
24 changes: 11 additions & 13 deletions docs/build/build-oracle.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,20 @@ Oracles serve many purposes for application builders. For example:

Oracle solutions range from centralized and trusted to decentralized and game-theory based. On the
centralized end of the spectrum, an oracle could be a single account that has the authority to
dictate the real-world data on-chain. On the decentralized end, a [complex game of
"chicken"][schellingcoin] can be played among various staked actors who risk getting slashed if they
don't submit the same data as everyone else. Solutions such as [Chainlink][chainlink] fit somewhere
in the middle, where the amount of trust you put into the reporting oracles can be adjusted based on
your preferences. A Chainlink [Feed Pallet][feed pallet] was recently released to allow smart
contract applications across {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} to
access price reference data, made available as a Substrate oracle pallet.
dictate the real-world data on-chain. On the decentralized end, a
[complex game of "chicken"](https://blog.ethereum.org/2014/03/28/schellingcoin-a-minimal-trust-universal-data-feed/)
can be played among various staked actors who risk getting slashed if they don't submit the same
data as everyone else. Solutions such as
[Chainlink](https://polkadot.network/chainlink-reaches-milestone-with-polkadot/) fit somewhere in
the middle, where the amount of trust you put into the reporting oracles can be adjusted based on
your preferences. A Chainlink
[Feed Pallet](https://github.com/smartcontractkit/chainlink-polkadot/blob/master/pallet-chainlink-feed/README.md)
was recently released to allow smart contract applications across
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} to access price reference data, made
available as a Substrate oracle pallet.

When using an oracle in your application you should be aware of the benefits and risks that are
baked into its specific model. As the {{ polkadot: Polkadot :polkadot }}
{{ kusama: Kusama :kusama }} ecosystem develops and oracle parachains begin to appear, this article
will be updated with a comparison of the different solutions and the benefits and drawbacks that
each provide.

[schellingcoin]:
https://blog.ethereum.org/2014/03/28/schellingcoin-a-minimal-trust-universal-data-feed/
[chainlink]: https://polkadot.network/chainlink-reaches-milestone-with-polkadot/
[feed pallet]:
https://github.com/smartcontractkit/chainlink-polkadot/blob/master/pallet-chainlink-feed/README.md
33 changes: 13 additions & 20 deletions docs/build/build-smart-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,16 @@ transitions, they can support smart contracts.

Substrate presently supports smart contracts out-of-the-box in two ways:

- The EVM pallet offered by [Frontier][].
- The [Contracts pallet][] in the FRAME library for Wasm-based contracts.
- The EVM pallet offered by [Frontier](https://github.com/paritytech/frontier).
- The [Contracts pallet](https://github.com/paritytech/substrate/blob/master/frame/contracts/) in
the FRAME library for Wasm-based contracts.

### Frontier EVM Contracts

[Frontier][] is the suite of tools that enables a Substrate chain to run Ethereum contracts (EVM)
natively with the same API/RPC interface, Ethereum exposes on Substrate. Ethereum Addresses can also
be mapped directly to and from Substrate's SS58 scheme from existing accounts.
[Frontier](https://github.com/paritytech/frontier) is the suite of tools that enables a Substrate
chain to run Ethereum contracts (EVM) natively with the same API/RPC interface, Ethereum exposes on
Substrate. Ethereum Addresses can also be mapped directly to and from Substrate's SS58 scheme from
existing accounts.

### Substrate Contracts

Expand Down Expand Up @@ -140,8 +142,8 @@ Some of these PSPs are targeting Substrate's `contracts` pallet:
in Rust and compiles to Wasm code. As it states in its README, it is still in an experimental phase
so brave developers should be aware that they might have a bumpy - but workable - development
experience. There are some projects that have built projects in ink! with a decent level of
complexity such as Plasm's [Plasma contracts][plasm plasma], so it is mature enough to start
building interesting things.
complexity such as Plasm's [Plasma contracts](https://github.com/staketechnologies/Plasm), so it is
mature enough to start building interesting things.

For interested developers, they can get started writing smart contracts using ink! by studying the
[examples](https://github.com/paritytech/ink/tree/master/examples) that were already written. These
Expand Down Expand Up @@ -198,7 +200,8 @@ launched as a parachain on Kusama. Parachain functionality is live, and features
incrementally released. The final phase of the launch will include EVM functionality and balance
transfers.

Try deploying a smart contract to Moonbeam by following their [documentation][moonbeam docs].
Try deploying a smart contract to Moonbeam by following their
[documentation](https://docs.moonbeam.network/).

#### Astar

Expand Down Expand Up @@ -246,21 +249,11 @@ head start on your project, allowing you to innovate and create something truly
If you have interesting ideas for smart contracts on
{{ polkadot: Polkadot, :polkadot }}{{ kusama: Kusama, :kusama }} feel free to drop into the
{{ polkadot: [Polkadot Watercooler](https://matrix.to/#/#polkadot-watercooler:matrix.org) :polkadot }}
{{ kusama: [Kusama Watercooler](https://matrix.to/#/#kusama-watercooler:matrix.org) :kusama }} to talk about
them. Developers may be interested in joining the
{{ kusama: [Kusama Watercooler](https://matrix.to/#/#kusama-watercooler:matrix.org) :kusama }} to
talk about them. Developers may be interested in joining the
[Polkadot Beginners Lounge](https://matrix.to/#/#polkadotnoobs:matrix.org) :polkadot }} or
[Substrate Technical](https://area51.stackexchange.com/proposals/126136/substrate) to ask their
questions. As always, keep up to date with Polkadot and Kusama by following the
[social channels](../general/community.md).

All the best.

[frontier]: https://github.com/paritytech/frontier
[contracts pallet]: https://github.com/paritytech/substrate/blob/master/frame/contracts/
[edgeware]: https://edgewa.re
[edgeware documentation]: https://docs.edgewa.re/
[edgeware contracts documentation]: https://main.edgeware.wiki/development/develop/smart-contracts
[plasm plasma]: https://github.com/staketechnologies/Plasm
[moonbeam]: https://moonbeam.network
[moonbeam docs]: https://docs.moonbeam.network/
[frontier]: (https://github.com/paritytech/frontier)
83 changes: 35 additions & 48 deletions docs/general/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,38 +288,48 @@ platform for everyone. This wiki offers a place for builders and maintainers to

For brand-new learners of Blockchain technology:

- The [Blockchain Fundamentals MOOC course][mooc] is a great introduction to start familiarizing
yourself with blockchain concepts such as cryptography and networks, and how these play into
things like decentralization and cryptocurrency.
- The
[Blockchain Fundamentals MOOC course](https://mooc.web3.foundation/course/blockchain-fundamentals/)
is a great introduction to start familiarizing yourself with blockchain concepts such as
cryptography and networks, and how these play into things like decentralization and
cryptocurrency.

This is recommended for users with backgrounds of all levels, and the course is free!

### 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
support why this direction is beneficial. This original white paper also explains how Polkadot's
core components work together to build this decentralized network.
- [Polkadot's overview paper][overview-paper] is an updated version of the white paper that
describes the protocol in more technical terms. We would recommend reading this overview paper if
you are interested in digging more into the protocol itself.
- [Polkadot's light paper][light-paper] is a visual, easy to read, and less technical introduction
into its blockchain technology. This paper dives into the components of Polkadot but is
understandable for both a non-technical and technical reader.
- [Polkadot for Beginners: A non-technical guide to decentralization, blockchains &
Polkadot][book] - a book funded by the Polkadot Treasury
- [Polkadot's specification][spec] is a GitHub repository that holds the latest Polkadot Host
protocol specification, Polkadot's specification tests of the many components of the network, and
the Polkadot Runtime specification. This repo holds algorithms and explores how various processes
function in the Polkadot network. The Polkadot specification takes Polkadot's ideas and concepts
from the light and the white paper but focuses on the technical specs of the technology.
- [Watching the Technical Explainer Videos][teched videos]: These are great introductory videos that
explain and demonstrate how to use Polkadot and its [User Interface][ui].
- 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].
- [Polkadot's original white paper](https://polkadot.network/PolkaDotPaper.pdf) is a technical
summary around one possible direction of implementing the Polkadot network. This paper uses
rationale and technical details to support why this direction is beneficial. This original white
paper also explains how Polkadot's core components work together to build this decentralized
network.
- [Polkadot's overview paper](https://github.com/w3f/research/blob/master/docs/papers/OverviewPaper-V1.pdf)
is an updated version of the white paper that describes the protocol in more technical terms. We
would recommend reading this overview paper if you are interested in digging more into the
protocol itself.
- [Polkadot's light paper](https://polkadot.network/Polkadot-lightpaper.pdf) is a visual, easy to
read, and less technical introduction into its blockchain technology. This paper dives into the
components of Polkadot but is understandable for both a non-technical and technical reader.
- [Polkadot for Beginners: A non-technical guide to decentralization, blockchains & Polkadot](https://linktr.ee/polkadotbook) -
a book funded by the Polkadot Treasury
- [Polkadot's specification](https://github.com/w3f/polkadot-spec) is a GitHub repository that holds
the latest Polkadot Host protocol specification, Polkadot's specification tests of the many
components of the network, and the Polkadot Runtime specification. This repo holds algorithms and
explores how various processes function in the Polkadot network. The Polkadot specification takes
Polkadot's ideas and concepts from the light and the white paper but focuses on the technical
specs of the technology.
- [Watching the Technical Explainer Videos](https://www.youtube.com/watch?v=mNStMPZjiHM&list=PLOyWqupZ-WGuAuS00rK-pebTMAOxW41W8):
These are great introductory videos that explain and demonstrate how to use Polkadot and its
[User Interface](https://polkadot.js.org/apps/).
- Reading
[What is Polkadot? A Brief Introduction](https://medium.com/polkadot-network/what-is-polkadot-a-brief-introduction-ca3eac9ddca5)
on Medium. There are also other great articles to read on
[Polkadot's Medium](https://medium.com/polkadot-network) or
[Web3 Foundation's Medium](https://medium.com/web3foundation).

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].
and maintain on the Kusama network, please head over to our
[Kusama Guide](https://guide.kusama.network/).

## Resources

Expand All @@ -344,26 +354,3 @@ and maintain on the Kusama network, please head over to our [Kusama Guide][kusam
- [Contributing Guide](contributing.md) - Rules for contributing to the wiki.
- [Polkadot Knowledge Base](https://support.polkadot.network/) - Troubleshooting resources for
specific errors and problems.

[mooc]: https://mooc.web3.foundation/course/blockchain-fundamentals/
[white-paper]: https://polkadot.network/PolkaDotPaper.pdf
[overview-paper]: https://github.com/w3f/research/blob/master/docs/papers/OverviewPaper-V1.pdf
[light-paper]: https://polkadot.network/Polkadot-lightpaper.pdf
[spec]: https://github.com/w3f/polkadot-spec
[teched videos]: https://www.youtube.com/watch?v=mNStMPZjiHM&list=PLOyWqupZ-WGuAuS00rK-pebTMAOxW41W8
[article]: https://medium.com/polkadot-network/what-is-polkadot-a-brief-introduction-ca3eac9ddca5
[p medium]: https://medium.com/polkadot-network
[w medium]: https://medium.com/web3foundation
[ui]: https://polkadot.js.org/apps/
[account generation]: ../learn/learn-account-generation.md
[transfer]: ../learn/learn-balance-transfers.md
[nominator]: ../maintain/maintain-guides-how-to-nominate-polkadot.md
[validator]: ../maintain/maintain-guides-how-to-validate-polkadot.md
[identity]: ../learn/learn-identity.md
[proxy]: ../learn/learn-proxies.md
[democracy]: ../maintain/maintain-guides-democracy.md
[council]: ../maintain/maintain-guides-how-to-join-council.md
[council voting]: ../maintain/maintain-guides-how-to-vote-councillor.md
[treasury]: ../learn/learn-treasury.md
[kusama guide]: https://guide.kusama.network/
[book]: https://linktr.ee/polkadotbook
8 changes: 4 additions & 4 deletions docs/general/kusama/kusama-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Kusama is owned by those who hold the Kusama tokens (KSM). There's no central ki
changes are made through the protocol's on-chain governance.

The network is a permissionless and anyone can come along and start using it. Those who participated
in the Polkadot sale can claim a proportional amount of KSM through the [Kusama Claims
process][claims].
in the Polkadot sale can claim a proportional amount of KSM through the
[Kusama Claims process](kusama-claims).

Kusama is experimental. **Expect Chaos**.

Expand Down Expand Up @@ -178,8 +178,8 @@ nominating), governance, parachain auctions, basic transfers and everything else

<br />

For brand-new learners of Kusama's cousin network, Polkadot, please head over to the [Polkadot
Wiki][].
For brand-new learners of Kusama's cousin network, Polkadot, please head over to the
[Polkadot Wiki](https://wiki.polkadot.network/).

### Kusama Gifts

Expand Down
Loading

0 comments on commit 5dc3494

Please sign in to comment.