From 26406f4db81e2ad6fef9c86b298bfe8ad0abb98e Mon Sep 17 00:00:00 2001 From: laurencedelisle <53497147+laurencedelisle@users.noreply.github.com> Date: Wed, 12 Oct 2022 20:50:26 -0700 Subject: [PATCH 1/3] Update README.md replaced initial svelt README with README for contributors --- docs/README.md | 39 ++++++++++----------------------------- 1 file changed, 10 insertions(+), 29 deletions(-) diff --git a/docs/README.md b/docs/README.md index 374efec4c..e06b9dd98 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,38 +1,19 @@ -# 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 -# 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 - -# 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 -``` - -You can preview the production build with `npm run preview`. - -> 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) \ No newline at end of file From 132c005ea8e6b3e48f15f83e41528a28a9978edf Mon Sep 17 00:00:00 2001 From: laurencedelisle <53497147+laurencedelisle@users.noreply.github.com> Date: Mon, 17 Oct 2022 13:40:25 -0700 Subject: [PATCH 2/3] Update docs/README.md Co-authored-by: Adam Carpenter --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index e06b9dd98..6e193bc38 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,7 +6,7 @@ Install [yarn](https://classic.yarnpkg.com/en/docs/install) ## Running docs server locally -Run +Run the following command within the `docs/` folder ```sh yarn && yarn dev From 2a7a064cba5b87cec2893f43e225fd4a6170e834 Mon Sep 17 00:00:00 2001 From: laurencedelisle <53497147+laurencedelisle@users.noreply.github.com> Date: Mon, 17 Oct 2022 13:40:36 -0700 Subject: [PATCH 3/3] Update docs/README.md Co-authored-by: Adam Carpenter --- docs/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 6e193bc38..cbe2776a3 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,4 +16,10 @@ The server should start on [localhost:3000](http://localhost:3000/). ## Contributing -PR should target branch [docs-develop](https://github.com/blocknative/web3-onboard/tree/docs-develop) \ No newline at end of file +Confirm changes look as expected on local instance. + +Run `yarn build` and confirm no errors present from the proposed changes. + +Confirm vercel build within PR builds without error and check instance deployment for accuracy. + +PR should target branch [docs-develop](https://github.com/blocknative/web3-onboard/tree/docs-develop). \ No newline at end of file