Merge pull request #1319 from blocknative/docs-readme-updates

Docs readme updates

Author: laurencedelisle

docs/README.md

@@ -1,38 +1,25 @@
-# create-svelte
+# Docs
 
-Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte).
+## Prereqs
 
-## Creating a project
+Install [yarn](https://classic.yarnpkg.com/en/docs/install)
 
-If you're seeing this, you've probably already done this step. Congrats!
+## Running docs server locally
 
-```bash
-# create a new project in the current directory
-npm init svelte
+Run the following command within the `docs/` folder
 
-# create a new project in my-app
-npm init svelte my-app
+```sh
+yarn && yarn dev
 ```
 
-## Developing
+The server should start on [localhost:3000](http://localhost:3000/).
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+## Contributing
 
-```bash
-npm run dev
+Confirm changes look as expected on local instance.
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
-
-## Building
-
-To create a production version of your app:
-
-```bash
-npm run build
-```
+Run `yarn build` and confirm no errors present from the proposed changes.
 
-You can preview the production build with `npm run preview`.
+Confirm vercel build within PR builds without error and check instance deployment for accuracy.
 
-> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
+PR should target branch [docs-develop](https://github.com/blocknative/web3-onboard/tree/docs-develop).