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/9] 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/9] 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/9] 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 From 41f65afb6463594165c2b83a635faf5358f0956f Mon Sep 17 00:00:00 2001 From: Murat Akdeniz Date: Mon, 17 Oct 2022 15:02:19 -0700 Subject: [PATCH 4/9] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 55f09836c..46b4be6a3 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ If you're coming from v1, we've created a [migration guide for you](https://docs ## Documentation -For full documentation, check out the README.md for each package: +For full documentation, check out the README.md for each package or the [docs page here](https://onboard.blocknative.com/docs/overview/introduction#features): **Core Repo** From 94379c7b06b9c163311d35010ba4c9f3ba26c570 Mon Sep 17 00:00:00 2001 From: Murat Akdeniz Date: Mon, 17 Oct 2022 15:04:06 -0700 Subject: [PATCH 5/9] Update [...2]onboard.js-migration-guide.md --- .../docs/[...1]overview/[...2]onboard.js-migration-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md b/docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md index 7f2ff1809..b90871261 100644 --- a/docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md +++ b/docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md @@ -1,5 +1,5 @@ --- -sidebar_title: "Migration Guide: Web3-Onboard" +sidebar_title: "Migration Guide from v1" --- # Migration Guide from onboard.js to web3-onboard From 80f0c0ca4ddfbe919ffe4122f62a5a58fbfd2786 Mon Sep 17 00:00:00 2001 From: Murat Akdeniz Date: Mon, 17 Oct 2022 15:04:48 -0700 Subject: [PATCH 6/9] Rename [...2]onboard.js-migration-guide.md to [...3]onboard.js-migration-guide.md --- ....js-migration-guide.md => [...3]onboard.js-migration-guide.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/src/routes/docs/[...1]overview/{[...2]onboard.js-migration-guide.md => [...3]onboard.js-migration-guide.md} (100%) diff --git a/docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md b/docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide.md similarity index 100% rename from docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md rename to docs/src/routes/docs/[...1]overview/[...3]onboard.js-migration-guide.md From 5a44955143f6f4ddcf4335df2ac9de3193abd354 Mon Sep 17 00:00:00 2001 From: Murat Akdeniz Date: Mon, 17 Oct 2022 15:06:41 -0700 Subject: [PATCH 7/9] creating contribution guide --- .../[...2]contribution-guide.md | 33 +++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md diff --git a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md new file mode 100644 index 000000000..e319ef025 --- /dev/null +++ b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md @@ -0,0 +1,33 @@ +## How can I contribute? + +### Reporting Bugs + +Before creating an issue for a bug, please do a search through the Web3 Onboard issues to make sure that one has not already been created. You may find that someone else has run in to that issue and there may be a fix that has been released in a newer update. + +If an issue does not exist for the bug that you want to report, go ahead and create an issue, making sure to add as much detail as possible and following the issue template instructions. + +Once an issue has been created, one of the Web3 Onboard maintainers will take a look and will respond typically within a few days. The initial response will usually just acknowledge the issue and will indicate what will happen next. + +### Pull Requests + +If there is a feature or change that you would like to see in Web3 Onboard, you can fork the repo and make a pull request to have the changes merged in to the main repo and released as part of the official packages. + +Once a PR is created, one of the Web3 Onboard maintainers will acknowledge the PR and add it to our sprint planning to be reviewed as soon as possible. + +### How can I get a new wallet added? + +Web3 Onboard does not require a wallet to be a part of the main codebase to work, so a wallet module can be created and used for your project without needing anything to happen within the Web3Onboard codebase. If you would like the wallet to be part of the official Web3 Onboard packages and repo, then create a pull request. + +If the wallet you are adding is an “injected” wallet (browser extension, mobile dapp browser wallet), you can add a wallet to the injected wallets module. [See here for an example of pull request.](https://github.com/blocknative/web3-onboard/pull/1177/files) + +Otherwise if the wallet you are adding requires adding dependencies and initialization (SDK), then you will need to create a new package in the Web3 Onboard monorepo. [See here for an example of a pull request.](https://github.com/blocknative/web3-onboard/pull/1238/files) + +If you cannot write the code yourself to add a new wallet, then go ahead and create a feature request issue which may be considered by the maintainers or someone else in the community. + +## Feedback + +Jump in to our discord server to provide any feedback you feel is worth sharing. Could the docs be improved? Did you have trouble integrating? Feature requests etc. + +## Support + +For general questions about how to use Web3 Onboard you can first check out our [docs](https://onboard.blocknative.com/docs/overview/introduction#features) to see if there is an answer there, or you can head to our [Discord](https://discord.com/invite/KZaBVME) for support from the Blocknative team From 9b92782b67a022d3dd207944d31ef506cfe479e4 Mon Sep 17 00:00:00 2001 From: Murat Akdeniz Date: Mon, 17 Oct 2022 15:18:40 -0700 Subject: [PATCH 8/9] added docs contribution guidelines --- .../[...1]overview/[...2]contribution-guide.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md index e319ef025..b63227630 100644 --- a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md +++ b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md @@ -1,4 +1,8 @@ -## How can I contribute? +--- +sidebar_title: "Contribution Guide" +--- + +## How can I contribute to web3-onboard? ### Reporting Bugs @@ -16,14 +20,18 @@ Once a PR is created, one of the Web3 Onboard maintainers will acknowledge the P ### How can I get a new wallet added? -Web3 Onboard does not require a wallet to be a part of the main codebase to work, so a wallet module can be created and used for your project without needing anything to happen within the Web3Onboard codebase. If you would like the wallet to be part of the official Web3 Onboard packages and repo, then create a pull request. +Web3 Onboard does not require a wallet to be a part of the main codebase to work, so a wallet module can be created and used for your project without needing anything to happen within the Web3Onboard codebase. If you would like the wallet to be part of the official Web3 Onboard packages and repo, then create a pull request, and make sure to add any documentation updates by creating a docs pull request. -If the wallet you are adding is an “injected” wallet (browser extension, mobile dapp browser wallet), you can add a wallet to the injected wallets module. [See here for an example of pull request.](https://github.com/blocknative/web3-onboard/pull/1177/files) +If the wallet you are adding is an “injected” wallet (browser extension, mobile dapp browser wallet), you can add a wallet to the injected wallets module. [See here for an example of pull request.](https://github.com/blocknative/web3-onboard/pull/1177/files) You should also add the wallet to the [natively supported injected wallets list](https://onboard.blocknative.com/docs/packages/injected#injected-wallets-supported-natively). Otherwise if the wallet you are adding requires adding dependencies and initialization (SDK), then you will need to create a new package in the Web3 Onboard monorepo. [See here for an example of a pull request.](https://github.com/blocknative/web3-onboard/pull/1238/files) If you cannot write the code yourself to add a new wallet, then go ahead and create a feature request issue which may be considered by the maintainers or someone else in the community. +### Documentation contributions + +In order to contribute to the docs, you'll have to create a PR on the [docs-develop branch](https://github.com/blocknative/web3-onboard/tree/docs-develop). If you contribute code, you should definitely document it appropriately. We highly encourage the community to improve web3-onboard docs, if you have any questions don't hesitate to reach out. + ## Feedback Jump in to our discord server to provide any feedback you feel is worth sharing. Could the docs be improved? Did you have trouble integrating? Feature requests etc. From 152345d1917c43f4ba45e3b10057f67d6c815974 Mon Sep 17 00:00:00 2001 From: Murat Akdeniz Date: Mon, 17 Oct 2022 15:19:37 -0700 Subject: [PATCH 9/9] minor typo fix --- docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md index b63227630..244fdec01 100644 --- a/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md +++ b/docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md @@ -22,7 +22,7 @@ Once a PR is created, one of the Web3 Onboard maintainers will acknowledge the P Web3 Onboard does not require a wallet to be a part of the main codebase to work, so a wallet module can be created and used for your project without needing anything to happen within the Web3Onboard codebase. If you would like the wallet to be part of the official Web3 Onboard packages and repo, then create a pull request, and make sure to add any documentation updates by creating a docs pull request. -If the wallet you are adding is an “injected” wallet (browser extension, mobile dapp browser wallet), you can add a wallet to the injected wallets module. [See here for an example of pull request.](https://github.com/blocknative/web3-onboard/pull/1177/files) You should also add the wallet to the [natively supported injected wallets list](https://onboard.blocknative.com/docs/packages/injected#injected-wallets-supported-natively). +If the wallet you are adding is an “injected” wallet (browser extension, mobile dapp browser wallet), you can add a wallet to the injected wallets module. [See here for an example of an injected wallets pull request.](https://github.com/blocknative/web3-onboard/pull/1177/files) You should also add the wallet to the [natively supported injected wallets list](https://onboard.blocknative.com/docs/packages/injected#injected-wallets-supported-natively). Otherwise if the wallet you are adding requires adding dependencies and initialization (SDK), then you will need to create a new package in the Web3 Onboard monorepo. [See here for an example of a pull request.](https://github.com/blocknative/web3-onboard/pull/1238/files)