Merge branch 'master' into joshy-runtime-upgrade

Author: danforbes

.github/workflows/main.yml

@@ -1,20 +1,19 @@
 name: Build App
 
-on: 
+on:
   push:
-    branches: 
+    branches:
       - master
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - name: Run a one-line script
-      uses: peter-evans/repository-dispatch@v1
-      with:
-        token: ${{ secrets.ACCESS_TOKEN }}
-        repository: paritytech/substrate.io
-        event-type: content-update
-        client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+      - name: Run a one-line script
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.ACCESS_TOKEN }}
+          repository: paritytech/substrate.io
+          event-type: content-update
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "proseWrap": "always"
+}

README.md

@@ -1,34 +1,31 @@
 # Substrate Tutorials
 
-This repository holds documentation that goes in the Substrate Knowledge Base. The main website is hosted in [substrate-cms](https://github.com/substrate-developer-hub/substrate-cms).
+This repository holds documentation for Substrate tutorials. The main website is hosted in
+[substrate-cms](https://github.com/substrate-developer-hub/substrate-cms).
 
 ## Structure
 
-All docs are written in markdown format. The most up-to-date docs are in the `current` folder, while supporting figures and images go in the `assets` folder.
+All docs are written in markdown format. Each tutorial is in its own folder and has subfolders for
+each of its versions; supporting figures and images for all versions of all tutorials go in the
+`assets` folder.
 
 ## Contributing
 
-Feel free to add an issue if there is documentation that you'd like to see. See the [contributing guide](https://github.com/substrate-developer-hub/knowledge-base/blob/master/CONTRIBUTING.md) for guidance on making PRs.
+Feel free to add an issue if there is documentation that you'd like to see. See the
+[contributing guide](https://github.com/substrate-developer-hub/knowledge-base/blob/master/CONTRIBUTING.md)
+for guidance on making PRs.
 
-## Directory Structure
+### Prettier
 
-The knowledge base has six main categories. These are not meant to be a table of contents or
-imposed order in which to read documentation, but rather groups of articles within the same context
-and for similar audiences.
-
-1. **Getting Started:** Entry-level documentation. For example dependencies, installation, key
-  terms.
-1. **Learn Substrate:** Conceptual documentation. Articles about assumptions, key concepts, and
-  design decisions in Substrate that will help you make educated decisions about developing your
-  chain.
-1. **Runtime:** Documentation that goes more in-depth and covers topics specific to runtime
-  development like macros, storage, fees, and pallet architecture.
-1. **Smart Contracts:** A section dedicated to smart contracts on Substrate.
-1. **Integrate:** Documentation about integrating and interacting with your chain for node
-  operation, key management, and front-end development.
-1. **Advanced:** Sometimes you need more details than just the abstraction. The Advanced section
-  contains information about encoding/decoding, consensus, cryptography, etc.
+This repository uses [Prettier](https://prettier.io/) to ensure consistent formatting. Please run
+Prettier before submitting any changes to the files in this repository. Prettier ships as an
+[NPM](https://www.npmjs.com/) package, so NPM must installed to use it. Prettier can be installed
+globally with `npm i -g prettier` in which case you can run `prettier --write .` in the project
+root. If you prefer not to install Prettier you can run it on-the-fly with `npx prettier --write .`.
+In either case, the `.prettierrc.json` file that ships with repository will be used to ensure
+consistent formatting.
 
 ## License
 
-All documentation is under the [Apache 2 License](https://github.com/substrate-developer-hub/knowledge-base/blob/master/LICENSE).
+All documentation is under the
+[Apache 2 License](https://github.com/substrate-developer-hub/knowledge-base/blob/master/LICENSE).

config.json

@@ -1,11 +1,10 @@
 {
-	"current_version": "v2.0.0-alpha.6",
-	"display_order": [
-		"create-your-first-substrate-chain",
-		"build-a-dapp",
-		"start-a-private-network",
-		"perform-a-runtime-upgrade",
-		"add-a-pallet",
-		"pallet-in-own-crate"
-	]
+  "current_version": "v2.0.0-alpha.6",
+  "display_order": [
+    "create-your-first-substrate-chain",
+    "build-a-dapp",
+    "start-a-private-network",
+    "add-a-pallet",
+    "pallet-in-own-crate"
+  ]
 }

tuts/add-a-pallet/config.json

@@ -1,11 +1,9 @@
 {
-	"slug": "config",
-	"lang": "en",
-	"title": "Add a Pallet to your Runtime",
-	"excerpt": "Add the contracts pallet to your Substrate node template",
-	"tags": [ "Medium", "2 Hours", "No Prerequisites" ],
-	"versions": [ "v2.0.0-alpha.6", "v2.0.0-alpha.5" ],
-	"menu": [
-		{ "title": "Add a Pallet", "slug": "index" }
-	]
+  "slug": "config",
+  "lang": "en",
+  "title": "Add a Pallet to your Runtime",
+  "excerpt": "Add the contracts pallet to your Substrate node template",
+  "tags": ["Medium", "2 Hours", "No Prerequisites"],
+  "versions": ["v2.0.0-alpha.6", "v2.0.0-alpha.5"],
+  "menu": [{ "title": "Add a Pallet", "slug": "index" }]
 }