/zksync-docs

zkSync documentation

Primary LanguageShellMIT LicenseMIT

zkSync v1 Docs GitHub release (latest SemVer) GitHub Workflow Status

GitHub license npm version Follow us!

zkSync Documentation for the v1 | CHANGELOG

This repository contains the zkSync documentation hosted at docs.zksync.io

Development

Local run

yarn install --check-cache
yarn docs:dev

Development

CI pipeline will check that the files are formatted according markdownlint founds no issues in document and spelling is correct. Also, there should be no dead links.

You can check it locally as follows:

yarn
yarn md:lint
yarn cspell

If cspell doesn't recognize a word but you're sure that it's correct, consider adding it to the cspell-zksync.txt.

Deployment

master branch is automatically deployed to https://console.firebase.google.com/u/0/project/zksync-web-docs

Deploying altogether

will do:

  • install node modules;
  • prepare, test and build documentation;
  • afterwards all contained into the dist folder will be deployed in form of the static website
yarn install --check-cache
yarn docs:build
yarn firebase deploy

Extra documentation

cSpell

Configuration in cspell.json:

  • version — version of the setting file, always 0.1
  • language — language - current active spelling language
  • words[] — words - list of words to be always considered correct
  • dictionaries[]
"dictionaryDefinitions": [
    {
      "name": "zksync", "path": "./cspell-zksync.txt"
    }
]

{
  "version": "0.1",
  // language - current active spelling language
  "language": "en",
  // words - list of words to be always considered correct
  "words": [],
  "dictionaries": ["typescript", "zksync"],
  //
  "dictionaryDefinitions": [
  { 
    "name": "zksync", "path": "./cspell-zksync.txt"
  }
]
}

zkSync Ecosystem

BTW, we're hiring: See open positions

License

zkWallet is distributed under the terms of both the MIT license, and the Apache License (v.2.0).

See LICENSE-APACHE, LICENSE-MIT for details.