base on zkSync Era Documentation > [!WARNING] > zksync-web-era-docs will be archived shortly! > Find the latest at [zksync-docs](https://github.com/matter-labs/zksync-docs) > > For tutorials and guides, check out the [Community Code](https://github.com/zkSync-Community-Hub/community-code) repo. # zkSync Documentation [](CHANGELOG.md) [](https://github.com/matter-labs/zksync-web-era-docs/blob/main/LICENSE) [](https://github.com/matter-labs/zksync-web-era-docs/blob/main/LICENSE-APACHE) [](https://twitter.com/zksync) ## zkEVM > zkEVM is a virtual machine that executes smart contracts in a way that is compatible with zero-knowledge-proof computation. > Our zkEVM keeps EVM semantics, but is also ZK-friendly and adopts a traditional register-based CPU architecture. [zkSync Docs](https://docs.zksync.io) contain up-to-date information about **zkSync**. zkSync Era has built-in EVM compatibility which makes it a unified tool for releasing EVM-compatible ZK rollups. We call it [zkEVM](https://zksync.io/zkevm): web3, Layer 2, scaling functionality that preserves your battle-tested code and knowledge gained after years of working with Solidity. ## Build and setup ### Initial setup The frontend team chose the `yarn@berry` package manager, so ensure you install `node` version **LTS@14** after configuring `yarn`. ```bash # configure yarn version: berry or specifically 3.1.1. $ yarn set version berry ``` ### Main scripts ```bash # install dependencies $ yarn # serve with hot reload at localhost:8080 $ yarn docs:dev # static generation to dist $ yarn docs:build ``` ### Development The continuous integration pipeline uses `prettier` and `markdownlint` to ensure there are no issues with your document, that spelling is correct, and there are no dead links. You can check it locally as follows: ```bash # check dead links $ yarn lint:dead # check spelling $ yarn lint:spell # check with markdownlint $ yarn lint:mdl # check with prettier $ yarn lint:fmt # fix with markdownlint $ yarn fix:mdl # fix with prettier $ yarn fix:fmt # run all checks $ yarn ci # run all fixes $ yarn ci:fix # build for production $ yarn ci:build ``` If `lint:spell` doesn't recognize a word, and you’re sure that it’s correct, consider adding it to `cspell-zksync.txt`. ## Search We use Algolia to index our documentation. Know more about it [here](https://algolia.com). Dashboard is [here](https://dashboard.algolia.com/), and [Crawler Admin](https://crawler.algolia.com/) is here. ## Contributions ### Adding new tutorials To add a new tutorial: - Fork the repository and create a new branch locally to add your changes. - Add the tutorial markdown file inside the `build/tutorials` folder. - Give the file an SEO-friendly name, as it is included in the live URL. - In the `.vuepress/sidebar/en.ts` file, add the tutorial inside this block: ```js { text: "Tutorials", link: "/dev/tutorials", children: [ "/build/tutorials/cross-chain-tutorial.md", "/build/tutorials/custom-aa-tutorial.md", "/build/tutorials/aa-daily-spend-limit.md", "/build/tutorials/custom-paymaster-tutorial.md", // ADD YOUR FILE HERE ], }, ``` - If your tutorial contains images, make sure to compress them using https://squoosh.app/ before adding them to the `assets/images` folder. - Finally, create a PR. ### Deployment The `main` branch is automatically deployed to <https://console.firebase.google.com/u/0/project/aqwzx-zksync-v2-docs> Deploying does the following: - Installs node modules. - Prepares, tests, and builds documentation. - Deploys everything contained in the `dist` folder as a static website. ```bash yarn zk-ci-prepare yarn firebase deploy ``` ## Extra documentation ## cSpell Configuration in `.cSpell.json`: - `version` — version of the setting file, always **0.1**. - `language` — current active spelling language. - `words[]` — list of correctly-spelled words. - `dictionaries[]` ```json "dictionaryDefinitions": [ { "name": "zksync", "path": "./cspell-zksync.txt" } ] ``` ", Assign "at most 3 tags" to the expected json: {"id":"5875","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"