Skip to content

Commit

Permalink
docs: small improvements (#106)
Browse files Browse the repository at this point in the history
# Description

Small edits to build pages based on feedback. Move cards on Build /
Introduction page up to the top to prioritize them. Improved wording on
funding wallets with testnet funds on Build / Connect to zkSync

Add redirects for old /sdks paths to point to the new /sdk path
  • Loading branch information
itsacoyote authored Jun 5, 2024
1 parent 26c9d06 commit 6c665c1
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 22 deletions.
Binary file modified bun.lockb
Binary file not shown.
2 changes: 1 addition & 1 deletion components/layout/Toc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ const links = computed(() =>
{
icon: 'i-heroicons-chat-bubble-oval-left-ellipsis',
label: 'Share feedback',
to: `https://github.com/matter-labs/zksync-docs/issues/new?&template=feedback&page=https://docs.zksync.io${props.page?._path}`,
to: `https://github.com/matter-labs/zksync-docs/issues/new?labels=feedback%2Ctriage&projects=&template=feedback.yml&title=%5BFeedback%5D%3A+&page=https://docs.zksync.io${props.page?._path}`,
target: '_blank',
},
...(toc?.bottom?.links || []),
Expand Down
38 changes: 19 additions & 19 deletions content/00.build/00.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,25 @@ title: Introduction
description: Welcome to the zkSync Era Docs.
---

::card-group
::card
---
title: Quickstart
icon: i-heroicons-rocket-launch-solid
to: /build/quick-start
---
Experience a quick tutorial on building and deploying smart contracts on zkSync Era.
::
::card
---
title: zkSync 101
icon: i-heroicons-academic-cap-solid
to: /build/zksync-101
---
Learn to build projects locally for zkSync Era using zksync-cli.
::
::

**zkSync Era** is a Layer 2
**[ZK rollup](/build/resources/glossary#zk-rollup)**, a trustless protocol that
uses cryptographic validity proofs to provide scalable and low-cost transactions on Ethereum.
Expand Down Expand Up @@ -71,22 +90,3 @@ Interacting with applications built on zkSync Era is seamless, cheap and fast.
If you have not connected to zkSync Era before, you will need to
configure your wallet with the network. To add zkSync Era, see [Connect to zkSync Era](/build/connect-to-zksync).
::

::card-group
::card
---
title: Quickstart
icon: i-heroicons-rocket-launch-solid
to: /build/quick-start
---
Experience a quick tutorial on building and deploying smart contracts on zkSync Era.
::
::card
---
title: zkSync 101
icon: i-heroicons-academic-cap-solid
to: /build/zksync-101
---
Learn to build projects locally for zkSync Era using zksync-cli.
::
::
8 changes: 6 additions & 2 deletions content/00.build/01.connect-to-zksync.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ You can add zkSync Era to your MetaMask wallet using the buttons below:

:network-adder{ network="mainnet" } :network-adder{ network="testnet" }

If you are using a different in-browser wallet, the buttons above may also work for them.

## Manually add zkSync Era

To manually add zkSync Era as a custom network in your wallet, follow these steps:
Expand All @@ -25,6 +27,8 @@ To manually add zkSync Era as a custom network in your wallet, follow these step

:display-partial{ path="_partials/_testnet-network-details" }

## Funding your wallet
## Get testnet funds for your wallet

Once you have your wallet connected to a zkSync Era environment, [get testnet funds](/ecosystem/network-faucets) and [deploy your first smart contract](/build/quick-start/deploy-your-first-contract)
Once you have your wallet connected to a zkSync Era environment,
you can get testnet funds from one of many [testnet faucets](/ecosystem/network-faucets)
to use with [deploying your first smart contract](/build/quick-start/deploy-your-first-contract).
15 changes: 15 additions & 0 deletions firebase.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,21 @@
"public": ".output/public",
"ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
"redirects": [
{
"source": "/sdks/js/:path*.@(html|md)",
"destination": "/sdk/js/ethers/v5/:path",
"type": 301
},
{
"source": "/sdks/js/zksync-ethers/:path*.@(html|md)",
"destination": "/sdk/js/ethers/v6/:path",
"type": 301
},
{
"source": "/sdks/:path*.@(html|md)",
"destination": "/sdk/:path",
"type": 301
},
{
"source": "/build/quick-start/*.@(html|md)",
"destination": "/build/quick-start",
Expand Down

0 comments on commit 6c665c1

Please sign in to comment.