Merge pull request #1328 from blocknative/docs-develop

Docs release

Author: Adamj1232

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**
 

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).

docs/src/routes/docs/[...1]overview/[...2]contribution-guide.md

@@ -0,0 +1,41 @@
+---
+sidebar_title: "Contribution Guide"
+---
+
+## How can I contribute to web3-onboard?
+
+### 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, 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 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)
+
+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.
+
+## 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

docs/src/routes/docs/[...1]overview/[...2]onboard.js-migration-guide.md renamed to docs/src/routes/docs/[...1]overview/[...3]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