Giter Club home page Giter Club logo

polkadot-wiki-old's Introduction

Documentation Status CircleCI

Polkadot Wiki

This repository contains the source files for the Polkadot wiki.

Running locally

Note that you will need the pip package manager, which is generally installed with Python.

Clone the repository to your local file system.

git clone https://github.com/w3f/Polkadot-wiki.git

Install mkdocs by using the pip package manager.

pip install mkdocs --user

Now install all necessary dependencies, once again by using pip.

pip install -r requirements.txt

Run mkdocs serve from the repository root to spawn a hot reloading development server and navigate to localhost:8000 in a web browser.

Publishing

The wiki is hosted on Read the Docs and is built on each published commit to the master branch on the GitHub repository.

Styling

Mkdocs-Material is used to give the wiki its sleek theme.

Contributing

Please read over the rules for contribution at the CONTRIBUTING document.

Contributor set-up

As a contributor, you will need to run npm i in the local copy of your repository after you bring it down.

Adding a new page

If you add a page please ensure that you give it the correct placement in the navigation by manually inputting it in the mkdocs.yml under the nav field. It is done in this way in order to have more control in how pages are displayed on the UI and give better organization to topics.

Spellchecking

We set husky hooks up to catch spelling errors. If you are being prevented from committing, just run npm run spellcheck:interactive to use the interactive debugger and fix your spelling.

polkadot-wiki-old's People

Contributors

alxheller avatar ansonla3 avatar burdges avatar cool007zqw avatar emielsebastiaan avatar fgimenez avatar gavofyork avatar hackfisher avatar joepetrowski avatar laboon avatar lsaether avatar ltfschoen avatar mnaamani avatar pablanopete avatar phillux avatar retotrinkler avatar riusricardo avatar rphmeier avatar satoshi-kusumoto avatar sotawatanabe avatar tbaut avatar tokyoweb3 avatar web3foundation avatar xlc avatar zaxayn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

polkadot-wiki-old's Issues

Compare Polkadot to other blockchain solutions

How does Polkadot / Substrate compare to other blockchain solutions?

  • [] Polkadot vs. Ethereum (Runtime development vs. smart contracts)
  • [] Polkadot vs. Tezos (Governance comparison, VM comparison)
  • [] Polkadot vs. Cosmos (Interchain protocol comparison)

Smart Contracts on Polkadot

We should have a "Smart Contracts" page which is updated with the latest information on the SRML contracts module, the pDSL, Edgeware, and other teams which may be building a smart contract parachain.

In the long term it would be good for this page to turn into a mini developer's hub including simple tutorails. I think that Robbepop will start adding more documentation to the wiki on the pDSL repo, here so we may want to coordinate and work with him on that.

Add "Overview>Ecosystem"

Projects listed here:
here is AdEx Network in Bulgaria, ChainX and 万企融 in China, Commonwealth, Agoric, C3 and ChainLink in the US, Katallassos in Switzerland, Ocean, EWF and Asure Network in Germany, UniqX in the UK, iExec in France, Blink in Romania and Polkascan in The Netherlands.

Current Roadmap

Builders need some information about the roadmap of the project so that if they start building they know what to expect in the future.

  • Informational briefs of the roadmap of Polkadot as we understand it

Wiki Tracking

Wiki Tracking

Articles

  • How does interchain communication work?

Tutorials / Guides

  • How to Run a Validator #5

Governance

  • How to vote on a proposal #8
  • How to propose a referendum #14
  • How to submit a goverance proposal #23
  • How to become a polkadot council member #26

Learn

  • Governance #12
    • Council
  • Vote weighting and counting overview #13
  • Innovations (what is new in Polkadot) #40
  • Staking #44
  • Bridges #115

Node operators

  • Validator best practices #7
  • How to become a fisherman #9
  • Economics of being a validator or nominator

Builders

  • Example applications #10
  • Materials for workshops and hackathons #11
  • Builders best practices #17
  • CLI tools examples #18
  • Do and dont's #38
  • Smart contracts on Polkadot #52
  • Cumulus #59

Builders guides

The main story of these guides should take the reader through the complete cycle of making a parachain from start to finish. See #53

  • Making a Substrate chain compatible with Polkadot #20
  • How to run a collator node for your parachain #21
  • How to use ICMP with your parachain #37

Misc.

Enhancements

  • Last contributor note #94
  • Crosslinking glossary throughout #99

Story: Building a parachain from start to finish

It may be a little early to think about this but I think having a pro-active approach to creating it will pay off later.

Idea:

We have an "all-encompassing" beginners tutorial for creating specifically a parachain that will be deployed to Polkadot similar to the Substratekitties tutorial made by the Parity team.

Components:

  1. Creating a runtime with substrate (since Parity has already produced a ton of content for this let's not focus on it too heavily but we will still need to do it).
  2. Making your Substrate chain compatible with Polkadot
  3. Running a collator node for your parachain
  4. Interacting across the Polkadot network (Interchain communications)
  5. Deploying your parachain on the testnet
  6. Creating a UI (or using Polkadot UI) with your parachain

Purpose:

The Substrate developers hub already has really great tutorials for building a substrate chain (2 beginners tutorials, 1 intermediate) but there is not yet any work being done for a specifically Polkadot parachain tutorial (what we will do in this issue).

Tutorial: Interaction across parachains

As a developer I would want to know how to take advantage of Polkadot's interoperability across chains by learning how to develop a runtime module that does external calls to another chain.

  • [] How to make an external call to a separate parachain
  • [] How to receive a call that originated from an external parachain

Milestone: Deprecating the older Polkadot wiki

Tracking issue for the tasks that should be done before we fully deprecate the Polkadot GH wiki (ie the old one)

  • DOT
  • Governance included in next PR #56
  • Moving from PoC1 to PoC2 outdated: not needed
  • Parachains
  • Polkadot Extrinsics Format #56
  • Polkadot Roles and Actors Spread across the node operators pages
  • Polkadot UI
  • ?Style Guide Can be added to the wiki but I feel this should be part of the README of Polkadot repository instead #56
  • Validating on PoC1 outdated: not needed
  • Validating on PoC2 outdated: not needed
  • Validating on PoC3 "Alexander"

Once these pages have been migrated over we may place a deprecation notice on the old pages and redirect to the new pages.

Diagrams and Visuals Tracking

Diagrams and Visuals Tracking

Diagrams we need P3

  • Visual depicting difference between the parachains and relay chains (shown as blocks)
  • Diagram of Validator and Collator when validating a state transition against a STF
  • Diagram of Interchain communication (shown as blocks) something like below with the relay chain in the middle and the parachains around it, showing how a message will originate on one parachain and be places in the input queue of another.
  • Parachain auction diagram. Currently we have some ascii art, but there exists a diagram used in presentation. Maybe we can use or update the diagram?
  • Break apart the below complex image from the whitepaper into more digestible parts.
  • This image that outlines different traits of solo chains, parachains, and bridges looks like its a screen grab from the old website. Evaluate: Do we update?

Examples / Ideas

  • There are some Substrate / Polkadot related diagrams collected already in awesome-substrate. We should re-use these or determine if any should be updated by Iggy.
  • Substrate docs for Architecture of a Runtime has a diagram which is also clickable, allowing users to explore the architecture interactively. We can do something similar for Polkadot, where each layer of the stack is its own diagram with clickable parts. This could be something like a sitemap where it exists on its own page or it could be including on every relevant page.

Do and Do Nots

Development using runtime modules may not be suitable for every application. For example, it wouldn't make sense to commit sensitive data on chain that is meant to be private to users (like passwords). What are more warnings that can be given to developers as best practices? This can include security best practices but also recommendations about what kinds of applications work best as parachains or runtime modules.

Guide: How can I build with Polkadot

  • Where are we now?
  • What is your application?
  • Do you want a custom fee structure, specific monetary system with inflation and treasury, or optimized state transition function? Better to use Polkadot parachain.
  • Do you want easy to develop, easy to deploy, closer to other application ecosystems, easier to maintain? Smart contracts.
  • Parachain: Start writing on substrate
  • Parachain: Set up your chain links
  • Parachain: How do I deploy? Cumulus, collator node needs to be figured out on your chain, economics or organization, ensure fair validator choice
  • Parachain: How do I pay for it? Default Mechansim (Vickrey auction - see document), One or more contributors (ICO etc.) community, big company.. Or is it dictated by governance? For free because of usefulness or by custom payment?
  • Parachain: What happens when the slot ends?
  • Parachain: So what do I get? High security, messaging, tooling and monitoring, innovation in new chains
  • Smart Contract: Not ready yet, but look out for testnets Edgeware etc.
  • Smart Contract: How to deploy (send tx to deploy)
  • Smart Contract: How to pay for smart contract? Tx Fee, Subscription Model, Free Trial? Rent

Tools: Examples

Examples using the CLI tools to interact with Polkadot relay chain or parachain

Example applications

compile a curated list of example applications that developers may be interested in looking at

The major innovations of Polkadot / Substrate

Describe the major innovations of Polkadot. The target audience for this section would be higher-level than the other tech heavy sections, aimed more at tech leads or entrepreneurs who may be considering Polkadot as a tech stack for their next project or venture.

  • What is new about Polkadot?
    • Shared Security
    • Runtime modules
  • What does this new functionality enable?
    • Development of new custom blockchains

Transfer parachains page from old wiki

There is a good tutorial for viewing active parachains and deploying a parachain on the old wiki.

It needs to be updated for the recent Alexander testnet and tested for correctness, then moved over to the new wiki where it can be maintained.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.