feat: update zkSync to ZKsync (#121)

* feat: change zkSync to ZKsync

* chore: fix lint-staged rules

.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
-      about: These forms are for zkSync Docs related issues. If you have questions or need help, please visit the zksync-developers Discussion.
+      url: https://github.com/ZKsync-Community-Hub/zkync-developers/discussions
+      about: These forms are for ZKsync Docs related issues. If you have questions or need help, please visit the zksync-developers Discussion.

.github/pull_request_template.md

@@ -1,6 +1,6 @@
 <!--
 
-Thank you for contributing to the zkSync Docs!
+Thank you for contributing to the ZKsync Docs!
 
 Before submitting the PR, please make sure you do the following:
 

.lintstagedrc.yml

@@ -3,6 +3,6 @@
   - eslint
 '*.md':
   - markdownlint-cli2
-  - cspell check
+  - cspell lint --file
 '*.{json,yml}':
   - prettier --list-different

CODE_OF_CONDUCT.md

@@ -5,27 +5,27 @@ Version: 1.1
 Apache 2.0 license, derived from the Apache Foundation Code of Conduct.
 Also, CC BY-SA 3.0 derived from the Mozilla Community Participation Guidelines.
 
-Our goal is to cultivate a safe, friendly, and inclusive space that benefits all participants in the zkSync ecosystem.
+Our goal is to cultivate a safe, friendly, and inclusive space that benefits all participants in the ZKsync ecosystem.
 This Code of Conduct outlines our shared values and expectations to help ensure that the community remains a positive and enriching environment for everyone.
 
 ## When and how to use this Code of Conduct
 
-This is your guide for engaging as a participant in the zkSync ecosystem.
-It applies to all physical and digital spaces related to zkSync.
+This is your guide for engaging as a participant in the ZKsync ecosystem.
+It applies to all physical and digital spaces related to ZKsync.
 
 ## Expected behaviors
 
 **Be ethical**:
-We endeavor to enrich the zkSync ecosystem, while not infringing on the rights and wellbeing of others.
-We also endeavor to enrich ourselves without causing harm to the zkSync community.
+We endeavor to enrich the ZKsync ecosystem, while not infringing on the rights and wellbeing of others.
+We also endeavor to enrich ourselves without causing harm to the ZKsync community.
 We do not encourage tax evasion, promoting information leaks, speculating on tokens or token prices, or otherwise breaking the law.
 
 **Be kind and respectful**:
 Treat everyone with kindness, empathy, and respect.
 We all come from different backgrounds, perspectives and experiences,
 so let's celebrate our differences and foster a culture of openness and understanding.
 We may have strong feelings about other layer 1 and layer 2 blockchains,
-but that is no reason to disparage, defame, or slander any competitor to zkSync or what other chains are doing.
+but that is no reason to disparage, defame, or slander any competitor to ZKsync or what other chains are doing.
 Feel free to compare metrics and features, but keep to the facts and be respectful of all the builders in web3
 trying to advance freedom through blockchain technology!
 
@@ -50,7 +50,7 @@ We encourage questions, and redirect them to the appropriate channel if we do no
 Communication is key.
 Use clear and considerate language in your interactions.
 We aim to create a welcoming environment for users of all ages, so please avoid excessive profanity or explicit content.
-Remember that zkSync community members are a diverse bunch.
+Remember that ZKsync community members are a diverse bunch.
 English is our primary working language, but to help others where English is not their first language,
 be succinct and avoid acronyms where possible.
 
@@ -76,7 +76,7 @@ This includes, but is not limited to:
 - Advocating for, or encouraging, any of the above behavior.
 
 **Have fun and connect**:
-Finally, remember that ZK Squad and the zkSync community is a place to connect, learn, and enjoy.
+Finally, remember that ZK Squad and the ZKsync community is a place to connect, learn, and enjoy.
 Participate in a manner that encourages positive interactions and enhances the experiences of all.
 
 ## Managing violations

README.md

@@ -1,13 +1,13 @@
-# 🌟 zkSync Developer Documentation
+# 🌟 ZKsync Developer Documentation
 
 [![License](https://img.shields.io/badge/license-MIT-blue)](LICENSE-MIT)
 [![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-orange)](LICENSE-APACHE)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://www.contributor-covenant.org/)
 [![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-orange)](CONTRIBUTING.md)
 [![X (formerly Twitter) Follow](https://badgen.net/badge/twitter/@zksyncDevs/1DA1F2?icon&label)](https://x.com/zksyncDevs)
 
-Welcome to the **zkSync Docs** repository! This is your go-to hub for all things
-zkSync. Dive into our comprehensive documentation whether you're just starting out or looking for advanced guides.
+Welcome to the **ZKsync Docs** repository! This is your go-to hub for all things
+ZKsync. Dive into our comprehensive documentation whether you're just starting out or looking for advanced guides.
 
 ## 🚀 Quick Start
 
@@ -26,19 +26,19 @@ zkSync. Dive into our comprehensive documentation whether you're just starting o
 
 ## 📚 Documentation Overview
 
-Unlock the full potential of zkSync with our comprehensive resources:
+Unlock the full potential of ZKsync with our comprehensive resources:
 
 - **🛠️ Build:** Learn how to develop and deploy your smart contracts and
-applications on zkSync Era. Our step-by-step guides and tutorials will help you get started quickly and efficiently.
+applications on ZKsync Era. Our step-by-step guides and tutorials will help you get started quickly and efficiently.
 
 - **🔗 ZK Stack:** Dive into the Zero-Knowledge (ZK) Stack to discover how to
 configure and build a ZK chain tailored for your application. Explore the architecture, components, and best practices.
 
-- **🌐 zkSync Node:** Set up and run your own zkSync full node. Gain a deeper
+- **🌐 ZKsync Node:** Set up and run your own ZKsync full node. Gain a deeper
 understanding of node operations, observability, and maintenance to ensure optimal performance and reliability.
 
-- **🌍 Ecosystem:** Explore the vibrant zkSync ecosystem. Discover a wide array
-of projects and tooling built for zkSync developers and users, from wallets and
+- **🌍 Ecosystem:** Explore the vibrant ZKsync ecosystem. Discover a wide array
+of projects and tooling built for ZKsync developers and users, from wallets and
 explorers to integrations and developer tools. Stay updated with the latest innovations and community contributions.
 
 ## 🛠️ Built With
@@ -101,4 +101,4 @@ We welcome contributions from the community! Check out the following resources t
 If you want to contribute tutorials to our Docs, check out the
 [Community Code repo](https://github.com/zkSync-Community-Hub/community-code?tab=readme-ov-file#community-code)!
 
-Join us in making zkSync Docs better for everyone! 🌐✨
+Join us in making ZKsync Docs better for everyone! 🌐✨

SUPPORT.md

@@ -5,22 +5,22 @@ We have multiple channels available for you to request help.
 
 ## Where to get help
 
-If you're in need of help with authoring your content for zkSync Docs,
+If you're in need of help with authoring your content for ZKsync Docs,
 first read through the [Contribution Guidelines](https://docs.zksync.io/build/contributing-to-documentation/contribution-guidelines)
 to see if it may help answer some questions.
 If the content there does not solve your problem, submit an [issue in GitHub](https://github.com/matter-labs/zksync-docs/issues)
 and we can try to help resolve the issue.
 
 ### Help with developer related issues
 If you are referencing the documentation for a project as a developer and run into issues,
-you can go to the [zksync-developers Discussions](https://github.com/zkSync-Community-Hub/zksync-developers/discussions)
+you can go to the [zksync-developers Discussions](https://github.com/ZKsync-Community-Hub/zksync-developers/discussions)
 where you can submit a question. We also have a [Discord community](https://join.zksync.dev/)
 that may help with any troubleshooting.
 
-If you have questions related to any of our zkSync tools,
+If you have questions related to any of our ZKsync tools,
 we recommend that you submit an Issue related to that project.
 You can find the list of our open-source repositories in the [Contribution Track](https://docs.zksync.io/build/resources/contribution-track)
-on our zkSync Docs site.
+on our ZKsync Docs site.
 
 ## 🪲 Submit a bug report
 

app.config.ts

@@ -5,6 +5,6 @@
  */
 export default defineAppConfig({
   seo: {
-    siteName: 'zkSync Docs',
+    siteName: 'ZKsyncDocs',
   },
 });

app.vue

@@ -25,11 +25,11 @@ useSeoMeta({
   ogUrl: 'https://docs.zksync.io',
   ogImageAlt: 'Hyperscaling Ethereum with ZK tech.',
   ogDescription:
-    'zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and ZK chains. 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 ZK chains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
   description:
-    'zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and ZK chains. 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 ZK chains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
   twitterDescription:
-    'zkSync Docs bring you all information you need about our protocol, APIs, SDKs, ZK Stack, and ZK chains. 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 ZK chains. Start with our guides and tutorials, or go deep into our architecture and protocol specification.',
   twitterTitle: `%s`,
   twitterCard: 'summary_large_image',
   twitterSite: '@zksync',

content/00.build/00.index.md

@@ -1,6 +1,6 @@
 ---
 title: Introduction
-description: Welcome to the zkSync Era Docs.
+description: Welcome to the ZKsync Era Docs.
 ---
 
 ::card-group
@@ -10,32 +10,32 @@ description: Welcome to the zkSync Era Docs.
   icon: i-heroicons-rocket-launch-solid
   to: /build/quick-start
   ---
-  Experience a quick tutorial on building and deploying smart contracts on zkSync Era.
+  Experience a quick tutorial on building and deploying smart contracts on ZKsync Era.
   ::
   ::card
   ---
-  title: zkSync 101
+  title: ZKsync 101
   icon: i-heroicons-academic-cap-solid
   to: /build/zksync-101
   ---
-  Learn to build projects locally for zkSync Era using zksync-cli.
+  Learn to build projects locally for ZKsync Era using zksync-cli.
   ::
 ::
 
-**zkSync Era** is a Layer 2
+**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.
-In zkSync Era, computation is performed off-chain and most data is stored off-chain as well.
+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 Ethereum, users enjoy the same security
 warranties as in the L1.
 
-zkSync Era is made to look and feel like Ethereum, but with a higher throughput and lower fees.
+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 in
 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 box.
+ZKsync supports existing Ethereum wallets out of the box.
 
 ## Main features
 :check-icon Security inherited from Ethereum, with zero reliance on 3rd parties.
@@ -51,11 +51,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.
 
@@ -78,7 +78,7 @@ locally](/build/test-and-debug/)**.
 
 ## 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 ([average transaction costs](https://www.growthepie.xyz/fundamentals/transaction-costs)).
@@ -87,6 +87,6 @@ Interacting with applications built on zkSync Era is seamless, cheap and fast.
 - Support for existing Ethereum-based wallets like Metamask, TrustWallet, Zerion, Rabby, etc.
 
 ::callout{icon="i-heroicons-cube-transparent-solid" color="blue"}
-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).
+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).
 ::

content/00.build/01.connect-to-zksync.md

@@ -1,23 +1,23 @@
 ---
-title: Connect to zkSync Era
-description: Step-by-step guide to connect your wallet to zkSync Era mainnet and testnet.
+title: Connect to ZKsync Era
+description: Step-by-step guide to connect your wallet to ZKsync Era mainnet and testnet.
 ---
 
-## Add zkSync Era to your MetaMask wallet
+## Add ZKsync Era to your MetaMask wallet
 
-You can add zkSync Era to your MetaMask wallet using the buttons below:
+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
+## Manually add ZKsync Era
 
-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).
 1. Click on “Add Network" and "Add network manually".
-1. Fill in the following details for the zkSync Era network environments:
+1. Fill in the following details for the ZKsync Era network environments:
 
 ### Mainnet network details
 
@@ -29,6 +29,6 @@ To manually add zkSync Era as a custom network in your wallet, follow these step
 
 ## Get testnet funds for your wallet
 
-Once you have your wallet connected to a zkSync Era environment,
+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).

content/00.build/05.quick-start/1.index.md

@@ -1,22 +1,22 @@
 ---
 title: Overview
-description: Learn how to interact with zkSync Era
+description: Learn how to interact with ZKsync Era
 ---
 
 Welcome to the Quickstart!
 
-This tutorial will help you to learn how to write, compile and deploy smart contracts to zkSync Era.
+This tutorial will help you to learn how to write, compile and deploy smart contracts to ZKsync Era.
 In the first step, you will build and deploy a simple contract and interact with it by sending messages.
 The second section will have you creating your own ERC20 token and the final section will
-introduce a specialized feature of zkSync Era, native account abstraction and paymasters.
+introduce a specialized feature of ZKsync Era, native account abstraction and paymasters.
 
-This section is designed for developers new to zkSync Era and uses online IDE's - Remix and AtlasZK -
+This section is designed for developers new to ZKsync Era and uses online IDE's - Remix and AtlasZK -
 to help you learn as quickly and efficiently as possible.
 
 ## Get started
 
-- If you haven't already added zkSync Era to your wallet, follow the instructions in [Connect zkSync Era to your wallet](/build/connect-to-zksync).
+- If you haven't already added ZKsync Era to your wallet, follow the instructions in [Connect ZKsync Era to your wallet](/build/connect-to-zksync).
 - Continue to [Deploy your first contract](/build/quick-start/deploy-your-first-contract) to learn how to use Remix or Atlas
-  to deploy a contract onto zkSync Era.
-- If you are familiar with zkSync Era and want to develop using `zksync-cli` locally
-  on your machine, you can jump over to the [zkSync 101](/build/zksync-101) section.
+  to deploy a contract onto ZKsync Era.
+- If you are familiar with ZKsync Era and want to develop using `zksync-cli` locally
+  on your machine, you can jump over to the [ZKsync 101](/build/zksync-101) section.