Feat zk reword (#49)

# What 💻 - new branch of #40 replaced zkSync with ZKsync # Why ✋ Branding change # Evidence 📷 Include screenshots, screen recordings, or `console` output here demonstrating that your changes work as intended   --------- Co-authored-by: bxpana <[email protected]>
matter-labs · May 1, 2024 · 8519129 · 8519129
1 parent 70a91e2
commit 8519129
Show file tree

Hide file tree

Showing 129 changed files with 746 additions and 752 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,7 +7,7 @@ assignees: ''
 
 ---
 
-### 🐛 Bug Report for zkSync Docs
+### 🐛 Bug Report for ZKsync Docs
 
 #### 📝 Description
 

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
 blank_issues_enabled: true
 contact_links:
     - name: zksync-developers Discussion
-      url: https://github.com/zkSync-Community-Hub/zkync-developers/discussions
+      url: https://github.com/ZKsync-Community-Hub/zkync-developers/discussions
       about: Please provide feedback, and ask questions here.
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # ZK Sync Docs
 
-Welcome to the ZK Sync Docs repository. This project serves as the community hub for zkSync, providing comprehensive
-documentation for developers. Whether you're a beginner looking to get started with zkSync or an experienced developer
+Welcome to the ZK Sync Docs repository. This project serves as the community hub for ZKsync, providing comprehensive
+documentation for developers. Whether you're a beginner looking to get started with ZKsync or an experienced developer
 seeking advanced guides, you'll find the resources you need here.
 
 ## Tools used
@@ -62,9 +62,9 @@ bun run lint:eslint
 
 ## Contributions
 
-We welcome contributions from the community to zkSync Docs.
+We welcome contributions from the community to ZKsync Docs.
 If you're looking for ideas on where to start with contributing, check out the [Contribution Overview](./content/90.contributing-to-documentation/10.index.md).
-To learn more on how to follow best practices when contributing to zkSync Docs,
+To learn more on how to follow best practices when contributing to ZKsync Docs,
 refer to the [Contribution Guidelines](./content/90.contributing-to-documentation/20.contribution-guidelines.md).
 If you are writing new content to add to the docs, the [Documentation Styleguide](./content/90.contributing-to-documentation/30.documentation-styleguide.md)
 can provide additional guidance.
diff --git a/app.config.ts b/app.config.ts
@@ -47,7 +47,7 @@ export default defineAppConfig({
     },
   },
   seo: {
-    siteName: 'zkSync Docs',
+    siteName: 'ZKsync Docs',
   },
   header: {
     logo: {
@@ -62,8 +62,8 @@ export default defineAppConfig({
         icon: 'i-simple-icons-github',
         to: 'https://github.com/matter-labs/zksync-docs',
         target: '_blank',
-        'aria-label': 'zkSync Docs on GitHub',
-        title: 'zkSync Docs on GitHub',
+        'aria-label': 'ZKsync Docs on GitHub',
+        title: 'ZKsync Docs on GitHub',
       },
     ],
   },
@@ -81,19 +81,19 @@ export default defineAppConfig({
         icon: 'i-simple-icons-x',
         to: 'https://x.com/zksync',
         target: '_blank',
-        'aria-label': 'zkSync on X',
+        'aria-label': 'ZKsync on X',
       },
       {
         icon: 'i-simple-icons-github',
         to: 'https://github.com/matter-labs',
         target: '_blank',
-        'aria-label': 'zkSync on GitHub',
+        'aria-label': 'ZKsync on GitHub',
       },
       {
         icon: 'i-simple-icons-discord',
         to: 'https://join.zksync.dev/',
         target: '_blank',
-        'aria-label': 'zkSync on Discord',
+        'aria-label': 'ZKsync on Discord',
       },
     ],
   },
@@ -113,7 +113,7 @@ export default defineAppConfig({
         {
           icon: 'i-heroicons-user-group-20-solid',
           label: 'Developer Forum',
-          to: 'https://github.com/zkSync-Community-Hub/zkync-developers/discussions',
+          to: 'https://github.com/ZKsync-Community-Hub/zkync-developers/discussions',
           target: '_blank',
         },
       ],

diff --git a/app.vue b/app.vue
@@ -18,12 +18,12 @@ useHead({
     {
       name: 'keywords',
       content:
-        'Documentation, Developers, Era, zkSync, ZK Stack, Matter Labs, rollup, ZK rollup, zero confirmation, ZKP, zero-knowledge proofs, Ethereum, crypto, blockchain, permissionless, L2, secure payments, scalable',
+        'Documentation, Developers, Era, ZKsync, ZK Stack, Matter Labs, rollup, ZK rollup, zero confirmation, ZKP, zero-knowledge proofs, Ethereum, crypto, blockchain, permissionless, L2, secure payments, scalable',
     },
     {
       name: 'description',
       content:
-        'zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
+        'ZKsync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
     },
     { name: 'author', content: 'https://matter-labs.io' },
   ],
@@ -38,14 +38,14 @@ useSeoMeta({
   ogSiteName: seo?.siteName,
   ogUrl: 'https://docs.zksync.io/',
   ogImage: 'https://docs.zksync.io/social-card.png',
-  ogImageAlt: 'zkSync — Accelerating the mass adoption of crypto for personal sovereignty.',
+  ogImageAlt: 'ZKsync — Accelerating the mass adoption of crypto for personal sovereignty.',
   ogDescription:
-    'zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
+    'ZKsync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and hyperchains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
   twitterImage: 'https://docs.zksync.io/social-card.png',
   twitterCard: 'summary_large_image',
   twitterSite: '@zksync',
   twitterCreator: '@the_matter_labs',
-  twitterImageAlt: 'zkSync — Accelerating the mass adoption of crypto for personal sovereignty.',
+  twitterImageAlt: 'ZKsync — Accelerating the mass adoption of crypto for personal sovereignty.',
 });
 
 provide('navigation', navigation);

diff --git a/components/content/NetworkAdder.vue b/components/content/NetworkAdder.vue
@@ -3,7 +3,7 @@ const props = defineProps({
   network: { type: String, required: true },
 });
 
-const chainName = props.network === 'mainnet' ? 'zkSync Era Mainnet' : 'zkSync Sepolia Testnet';
+const chainName = props.network === 'mainnet' ? 'ZKsync Era Mainnet' : 'ZKsync Sepolia Testnet';
 
 function addNetwork() {
   const config = {
@@ -40,7 +40,7 @@ function addNetwork() {
     type="button"
     icon="i-custom-metamask-logo"
     size="xl"
-    :variant="chainName === 'zkSync Era Mainnet' ? 'solid' : 'soft'"
+    :variant="chainName === 'ZKsync Era Mainnet' ? 'solid' : 'soft'"
     @click="addNetwork"
   >
     Add {{ chainName }}

diff --git a/content/00.build/00.zksync-101/1.zksync-overview.md b/content/00.build/00.zksync-101/1.zksync-overview.md
@@ -1,22 +1,22 @@
 ---
-title: zkSync overview
-description: A quick overview of what is zkSync
+title: ZKsync overview
+description: A quick overview of what is ZKsync
 ---
 
-## What is zkSync?
+## What is ZKsync?
 
-**zkSync Era** is a Layer 2 **[ZK
+**ZKsync Era** is a Layer 2 **[ZK
 rollup](https://docs.zksync.io/build/developer-reference/rollups.html#what-are-zk-rollups)**, a trustless protocol that
-uses cryptographic validity proofs to provide scalable and low-cost transactions on Ethereum. In zkSync Era, computation
+uses cryptographic validity proofs to provide scalable and low-cost transactions on Ethereum. In ZKsync Era, computation
 is performed off-chain and most data is stored off-chain as well. Transactions are bundled into batches before
 generating a validity proof. As all validity proofs are proven on the Ethereum mainchain, users enjoy the same security
 level as in Ethereum.
 
-zkSync Era is made to look and feel like Ethereum, but with a higher throughput and lower fees. Just like on Ethereum,
+ZKsync Era is made to look and feel like Ethereum, but with a higher throughput and lower fees. Just like on Ethereum,
 smart contracts are written in Solidity/Vyper and can be called using the same clients as the other EVM-compatible
 chains.
 
-You don't need to register a separate private key before using it; zkSync supports existing Ethereum wallets out of the
+You don't need to register a separate private key before using it; ZKsync supports existing Ethereum wallets out of the
 box.
 
 ## Main features
@@ -33,11 +33,11 @@ over transaction inputs.
 
 :check-icon Native account abstraction with improvements over EIP4337 (implemented in Ethereum and other rollups).
 
-You can find [more information about zkSync Era in l2beat](https://l2beat.com/scaling/projects/zksync-era#stage).
+You can find [more information about ZKsync Era in l2beat](https://l2beat.com/scaling/projects/zksync-era#stage).
 
 ## Developer experience
 
-zkSync Era was built to provide a similar developer experience as Ethereum.
+ZKsync Era was built to provide a similar developer experience as Ethereum.
 
 :check-icon Smart contracts can be written in Solidity or Vyper.
 
@@ -57,7 +57,7 @@ locally](https://docs.zksync.io/build/test-and-debug/getting-started.html)**.
 
 ## User experience
 
-Interacting with applications built on zkSync Era is seamless, cheap and fast.
+Interacting with applications built on ZKsync Era is seamless, cheap and fast.
 
 - Transactions have instant confirmations and fast finality on L1.
 - Transaction fees are extremely low (see [average transaction costs
@@ -68,6 +68,6 @@ Interacting with applications built on zkSync Era is seamless, cheap and fast.
 
 ## Get started
 
-- Follow [this guide to add the zkSync network to your wallet](connect-zksync).
+- Follow [this guide to add the ZKsync network to your wallet](connect-zksync).
 - Get [testnet funds from one of the faucets](/ecosystem/network-faucets)
-- Deploy your first smart contract to zkSync Era in the **[quickstart](quickstart)**.
+- Deploy your first smart contract to ZKsync Era in the **[quickstart](quickstart)**.
diff --git a/content/00.build/00.zksync-101/2.connect-zksync.md b/content/00.build/00.zksync-101/2.connect-zksync.md
@@ -1,26 +1,26 @@
 ---
-title: Connect to zkSync
-description: Step-by-step guide to connect your wallet to zkSync.
+title: Connect to ZKsync
+description: Step-by-step guide to connect your wallet to ZKsync.
 ---
 
-## Add zkSync Era to your wallet
+## Add ZKsync Era to your wallet
 
-You can add zkSync Era to your wallet using the buttons below:
+You can add ZKsync Era to your wallet using the buttons below:
 
 :network-adder{ network="mainnet" }
 :network-adder{ network="testnet" }
 
 ### Manual settings
 
-To manually add zkSync Era as a custom network in your wallet, follow these steps:
+To manually add ZKsync Era as a custom network in your wallet, follow these steps:
 
 1. Find the “Add Network” option in your wallet (in Metamask, you can find this in the networks dropdown).
 2. Click “Add Network"
-3. Fill in the following details for the zkSync Era network you want to add:
+3. Fill in the following details for the ZKsync Era network you want to add:
 
 #### Mainnet network details
 
-- Network Name: `zkSync Era Mainnet`
+- Network Name: `ZKsync Era Mainnet`
 - RPC URL: `https://mainnet.era.zksync.io`
 - Chain ID: `324`
 - Currency Symbol: `ETH`
@@ -29,14 +29,14 @@ To manually add zkSync Era as a custom network in your wallet, follow these step
 
 #### Sepolia testnet network details
 
-- Network Name: `zkSync Era Sepolia Testnet`
+- Network Name: `ZKsync Era Sepolia Testnet`
 - RPC URL: `https://sepolia.era.zksync.dev`
 - Chain ID: `300`
 - Currency Symbol: `ETH`
 - Block Explorer URL: `https://sepolia.explorer.zksync.io/`
 - WebSocket URL: `wss://sepolia.era.zksync.dev/ws`
 
-Click on "Save" to add the zkSync Era network to your wallet.
+Click on "Save" to add the ZKsync Era network to your wallet.
 
 ## How to get started?
 

diff --git a/content/00.build/00.zksync-101/3.quickstart.md b/content/00.build/00.zksync-101/3.quickstart.md
@@ -1,10 +1,10 @@
 ---
 title: Deploy your first contract
-description: Deploy a smart contract to zkSync from your browser in under 5 minutes 
+description: Deploy a smart contract to ZKsync from your browser in under 5 minutes
 ---
 
-This tutorial shows you how to deploy and interact with a smart contract on zkSync Era in less than 5 minutes.
-It will help you get familiar with the zkSync smart contract development and deployment process using different tools.
+This tutorial shows you how to deploy and interact with a smart contract on ZKsync Era in less than 5 minutes.
+It will help you get familiar with the ZKsync smart contract development and deployment process using different tools.
 
 This is what we're going to do:
 
@@ -17,7 +17,7 @@ This is what we're going to do:
 ## Prerequisites
 
 1. Before you start, make sure that
-[you’ve configured the zkSync Sepolia tesnet in your browser wallet by following the instructions here](connect-zksync).
+[you’ve configured the %%zk_testnet_name%% in your browser wallet by following the instructions here](connect-zksync).
 1. In addition, fund your wallet with %%zk_testnet_name%% ETH using [one of the available faucets](/ecosystem/network-faucets).
 
 ## Review the smart contract code
@@ -37,7 +37,7 @@ contract ZeekSecretMessages {
 
     constructor() {
         // Zeek initializes the contract with a welcome message
-        emit MessageReceived("Zeek welcomes you to zkSync!");
+        emit MessageReceived("Zeek welcomes you to ZKsync!");
     }
 
     // Function to send a "secret" message to Zeek
@@ -62,7 +62,7 @@ The Solidity smart contract contains two functions:
 - `getTotalMessages` returns the number of messages stored in the smart contract.
 
 ::callout{icon="i-heroicons-light-bulb"}
-zkSync Era is [EVM compatible](/build/resources/glossary#evm-compatible).
+ZKsync Era is [EVM compatible](/build/resources/glossary#evm-compatible).
 You can write smart contracts with Solidity or Vyper and use existing popular libraries like OpenZeppelin.
 ::
 
@@ -87,11 +87,11 @@ items: [{
 Copy the smart contract address from Atlas/Remix and search it via the [%%zk_testnet_name%%%%zk_testnet_block_explorer_url%%
 explorer](%%zk_testnet_block_explorer_url%%). You’ll see the contract has a transaction from the message we just sent.
 
-![Contract in zkSync explorer](/images/101-quickstart/101-contract-deployed.png)
+![Contract in ZKsync explorer](/images/101-quickstart/101-contract-deployed.png)
 
 Click on the transaction hash link to check all its details, like timestamp, the account that send it, transaction fee
-etc. The status will be “Processed” on zkSync and “Sending” on Ethereum. [Learn more about the transaction lifecycle on
-zkSync](/zk-stack/concepts/transaction-lifecycle).
+etc. The status will be “Processed” on ZKsync and “Sending” on Ethereum. [Learn more about the transaction lifecycle on
+ZKsync](/zk-stack/concepts/transaction-lifecycle).
 
 In the “Contract” tab you’ll see the contract source code as Atlas and Remix automatically verified the contract for us.
 When a smart contract is verified in a block explorer, it means that the source code of the contract has been published
@@ -100,22 +100,22 @@ code to understand its functions and intentions.
 
 Finally in the “Events” tab, you’ll see the replies from Zeek as these are emitted as events in our smart contract.
 
-![Contract events in zkSync explorer](/images/101-quickstart/101-contract-events.png)
+![Contract events in ZKsync explorer](/images/101-quickstart/101-contract-events.png)
 
 ZK is the endgame ✌️
 
 ## Takeaways
 
-- **EVM-compatibility**: zkSync Era is EVM-compatible and you can write smart contracts in Solidity or Vyper as in
+- **EVM-compatibility**: ZKsync Era is EVM-compatible and you can write smart contracts in Solidity or Vyper as in
   Ethereum.
-- **Custom compilers**: smart contracts deployed to zkSync Era must be compiled with the customs compilers: `zksolc` for
+- **Custom compilers**: smart contracts deployed to ZKsync Era must be compiled with the customs compilers: `zksolc` for
   Solidity and `zkvyper` for Vyper.
-- **Browser-based IDEs**: Existing tools like Atlas and Remix use zkSync custom compilers under the hood.
+- **Browser-based IDEs**: Existing tools like Atlas and Remix use ZKsync custom compilers under the hood.
 
 ## Next steps
 
-- Join the [zkSync developer community in Discord](https://join.zksync.dev/) where you can ask any questions about this tutorial in the #dev-101
+- Join the [ZKsync developer community in Discord](https://join.zksync.dev/) where you can ask any questions about this tutorial in the #dev-101
   channel
-- Continue learning by [deploying an ERC20 token to zkSync](erc20-token).
+- Continue learning by [deploying an ERC20 token to ZKsync](erc20-token).
 - Join our :external-link{text="GitHub Discussions Community" href="%%zk_git_repo_zksync-developers%%/discussions/"} to
-  help other devs building on zkSync or share your project.
+  help other devs building on ZKsync or share your project.
diff --git a/content/00.build/00.zksync-101/4.erc20-token.md b/content/00.build/00.zksync-101/4.erc20-token.md
@@ -13,7 +13,7 @@ This is what we’re going to do:
 
 ## Prerequisites
 
-Before you start, make sure that you’ve configured the zkSync Sepolia tesnet in your browser wallet by following the
+Before you start, make sure that you’ve configured the %%zk_testnet_name%% in your browser wallet by following the
 instructions here.
 
 In addition, fund your wallet with testnet ETH on %%zk_testnet_name%%.
@@ -34,12 +34,12 @@ items: [{
 
 ## Takeaways
 
-- **zkSync is EVM compatible** and supports existing smart contract libraries like OpenZeppelin
-- **Use popular libraries like** `ethers` , `viem`, or `web3.js` to interact with smart contracts deployed on zkSync.
+- **ZKsync is EVM compatible** and supports existing smart contract libraries like OpenZeppelin
+- **Use popular libraries like** `ethers` , `viem`, or `web3.js` to interact with smart contracts deployed on ZKsync.
 
 ## Next steps
 
-- Join the zkSync developer community in Discord where you can ask any questions about this tutorial in the #dev-101
+- Join the ZKsync developer community in Discord where you can ask any questions about this tutorial in the #dev-101
   channel
-- Continue learning by deploying an ERC20 token to zkSync Era.
-- Join our GitHub Discussions community to help other devs building on zkSync or share your project.
+- Continue learning by deploying an ERC20 token to ZKsync Era.
+- Join our GitHub Discussions community to help other devs building on ZKsync or share your project.
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ assignees: '' @@
     ---
-    ### 🐛 Bug Report for zkSync Docs
+    ### 🐛 Bug Report for ZKsync Docs
     #### 📝 Description
@@ Expand Down @@