Skip to content

Commit

Permalink
docs: add logo
Browse files Browse the repository at this point in the history
  • Loading branch information
tmm committed Aug 9, 2023
1 parent 66fa931 commit b20bb3e
Show file tree
Hide file tree
Showing 8 changed files with 93 additions and 32 deletions.
6 changes: 4 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,10 +123,10 @@ When adding new features or fixing bugs, it's important to add test cases to cov

## Writing documentation

Documentation is crucial to helping developers of all experience levels use wagmi. wagmi uses [VitePress](https://vitepress.dev) for the documentation site (located at [`site`](../site)). To start the site in dev mode, run:
Documentation is crucial to helping developers of all experience levels use wagmi. wagmi uses [VitePress](https://vitepress.dev) for the documentation site (located at [`docs`](../docs)). To start the site in dev mode, run:

```bash
pnpm site
pnpm docs:dev
```

Try to keep documentation brief and use plain language so folks of all experience levels can understand. If you think something is unclear or could be explained better, you are welcome to open a pull request.
Expand All @@ -144,6 +144,8 @@ When you're ready to submit a pull request, you can follow these naming conventi

When you submit a pull request, GitHub will automatically lint, build, and test your changes. If you see an ❌, it's most likely a bug in your code. Please, inspect the logs through the GitHub UI to find the cause.

**Please make sure that "Allow edits from maintainers" is enabled so the core team can make updates to your pull request if necessary.**

<div align="right">
<a href="#basic-guide">&uarr; back to top</a></b>
</div>
Expand Down
5 changes: 4 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,17 @@ layout: home
hero:
name: Wagmi
text: Reactivity for Ethereum apps
tagline: Build high-performance blockchain frontends.
tagline: Type Safe, Extensible, and Modular by design. Build high-performance blockchain frontends.
actions:
- theme: brand
text: Get Started
link: /react/getting-started
- theme: alt
text: Why Wagmi
link: /react/why-wagmi
image:
src: /logo-dark.svg
alt: VitePress

features:
- icon: 🚀
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
"react": "^18.2.0",
"unocss": "^0.53.0",
"viem": "^1",
"vitepress": "1.0.0-beta.6",
"vitepress": "1.0.0-rc.4",
"vitepress-plugin-shiki-twoslash": "^0.0.6",
"vue": "^3.3.4",
"wagmi": "workspace:*"
Expand Down
6 changes: 6 additions & 0 deletions docs/public/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 6 additions & 0 deletions docs/public/logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"@ledgerhq/connect-kit-loader@1.1.1": "patches/@ledgerhq__connect-kit-loader@1.1.1.patch",
"@safe-global/safe-apps-provider@0.17.1": "patches/@safe-global__safe-apps-provider@0.17.1.patch",
"@safe-global/safe-apps-sdk@8.0.0": "patches/@safe-global__safe-apps-sdk@8.0.0.patch",
"vitepress@1.0.0-beta.6": "patches/vitepress@1.0.0-beta.6.patch"
"vitepress@1.0.0-rc.4": "patches/vitepress@1.0.0-rc.4.patch"
},
"peerDependencyRules": {
"ignoreMissing": [
Expand Down
File renamed without changes.
98 changes: 71 additions & 27 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 comment on commit b20bb3e

@vercel
Copy link

@vercel vercel bot commented on b20bb3e Aug 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

wagmi-v2 – ./docs

wagmi-v2-wagmi-dev.vercel.app
alpha.wagmi.sh
wagmi-v2-git-alpha-wagmi-dev.vercel.app
wagmi-v2.vercel.app

Please sign in to comment.