✍️ Update documentation (#4638)

* Add the backend deployment to `admin.md`

* Update backend deployment doc

* Update the documentation

* Fix some more docs issues

* Fix the Quickstart scripts

* Fix the CI

* Fix the CI

* Update docs

* Fix docs issues

.github/workflows/CI.yml

@@ -202,6 +202,6 @@ jobs:
 
       - name: Run tests
         working-directory: packages/server
-        run: yarn test --silent
+        run: node $(yarn bin jest) --runInBand --silent
         env:
           DATABASE_URL: postgresql://postgres:postgres@localhost:5432/postgres

CONTRIBUTING.md

@@ -10,21 +10,21 @@ If you're looking for an issue to fix, take a look at the issues tagged [Good fi
 
 ## Contributing code
 
-Please follow the guide in the main [README](/README.md) on how to get started.
+Please follow the development guide [README](docs/README.md) to get started.
 
 ### Submitting Changes
 
 Please create a pull request from your fork. We may suggest some changes or improvements to make your changes fit overall architecture. However, small fixes or updates should be accepted quickly.
 
 The below guidelines will help you understand what it takes for the PR to be accepted:
 
-- Write tests (when including business logic) or add a storyboook (when you're creating a new component).
+- Write stories (with Storybook) to test your code, have a look [at the testing documentaion](docs/tests.md).
 - Provide a good PR title – it will be used as a commit message when the PR is merged
 - Follow the code style & make sure that your PR passes the CI
 - Use GitHub's special keywords to reference and/or close the issue automatically
 - Make sure that you've described your assumptions, unusual fixes or other information that may help the reviewer understand your code
-- Don't worry about squashing your commits – GitHub will do it for you. However, make your commit history clean as it will be included in the commit description as well.
+- Don't worry about squashing your commits – GitHub will do it for you.
 
 ### Branching strategy
 
-All PRs land in the `main` branch. Other branches are short-lived for development purposes. However, the archival branches exists under `/arch/*` – those consists prepared components or code that was not included in the main branch, but might be needed at later stage.
+All PRs land in the `dev` branch. The everything added to `main` gets deployed to [production](https://pioneerapp.xyz). Other branches are short-lived for development purposes. However, the archival branches exists under `/arch/*` – those consists prepared components or code that was not included in the main branch, but might be needed at later stage.

README.md

@@ -1,40 +1,42 @@
-![Pioneer](https://user-images.githubusercontent.com/247363/116713796-699da780-a9d5-11eb-82b1-a42bccd642d7.png)
-
-
-# Pioneer
-
-[![CI](https://github.com/Joystream/pioneer/actions/workflows/CI.yml/badge.svg)](https://github.com/Joystream/pioneer/actions/workflows/CI.yml)
-
-Governance application for the Joystream DAO platform.
-
-## Deployed version
-
-- The live production is available on [https://pioneerapp.xyz/)
-- Components preview and testing from `dev` branch, is available on [https://pioneer-2-storybook.vercel.app/](https://pioneer-2-storybook.vercel.app/).
-
-The deployed version can interact with two backends:
-
-- Joystream testnet – A deployed testnet.
-- Local – [A Joystream ecosystem running locally](docs/testenv.md).
+<h1 >
+    <a href="https://pioneerapp.xyz">
+        <img alt="Pioneer" src="https://user-images.githubusercontent.com/247363/116713796-699da780-a9d5-11eb-82b1-a42bccd642d7.png" />
+    </a>
+</h1>
+
+<h3 align="center">
+	Governance application for the Joystream DAO platform.
+</h3>
+
+<p align="center">
+	<strong>
+        <a href="https://pioneerapp.xyz">Live app</a>
+        •
+        <a href="docs/README.md">Docs</a>
+        •
+        <a href="https://pioneer-2-storybook.vercel.app">Storybook</a>
+	</strong>
+</p>
 
 ## Quickstart
 
-After cloning the repository run:
 
 ```shell
-## Install npm packages
-yarn
+## Clone this repository
+git clone [email protected]:Joystream/pioneer.git
 
-## Build all the sub-packages
-yarn build
+cd pioneer
+
+## Install npm packages
+yarn --immutable
 
 ## To start local development server
 yarn start
 
 ## To start local storybook instance
 yarn storybook
 
-## To run tests
+## To run tests (the back-end tests require docker in order to run)
 yarn test
 ```
 
@@ -50,9 +52,8 @@ To run a Pioneer instance check the [admin documentation](docs/admin.md)
 
 The project's monorepo contains packages:
 
-- [packages/ui](packages/ui) – The main Pioneer 2.0 package
-- [packages/types](packages/types) – A copy of [@joystream/types](https://github.com/Joystream/joystream/tree/master/types) checked out from the `master` branch.
-- [packages/metadata-protobuf](packages/metadata-protobuf) – A copy [@joystream/metadata-protobuf](https://github.com/Joystream/joystream/tree/master/metadata-protobuf) checked out from an `master` branch.
+- [packages/ui](packages/ui) – The Pioneer front-end package.
+- [packages/server](packages/server) – The Pioneer backend package.
 - [packages/markdown-editor](packages/markdown-editor) – A CKEditor 5 build used as Markdown editor.
 
 ## Contributing