feat(docs-structure): content update and migration (#829)

Co-authored-by: Ramon "9Tails" Canales <[email protected]> Co-authored-by: cooganb <[email protected]> Co-authored-by: MexicanAce <[email protected]> Co-authored-by: Antonio <[email protected]>
matter-labs · Jan 16, 2024 · b6fef08 · b6fef08
1 parent 5335e6f
commit b6fef08
Show file tree

Hide file tree

Showing 427 changed files with 22,798 additions and 4,336 deletions.
diff --git a/.github/workflows/deploy-preview.yml b/.github/workflows/deploy-preview.yml
@@ -22,17 +22,13 @@ jobs:
         run: |
           yarn set version 3.1.1
           yarn install
-      - name: "Generate rinkeby dist"
+      - name: "Generate preview dist"
         run: yarn run docs:build
 
-      - name: "Copy 404"
-        run: |
-          cp ./dist/docs/404.html ./dist/404.html
-
       - name: "Deploy preview"
         uses: matter-labs/action-hosting-deploy@main
         with:
           repoToken: '${{ secrets.GITHUB_TOKEN }}'
           firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_AQWZX_ZKSYNC_V2_DOCS }}"
-          target: prod
+          target: staging
           projectId: aqwzx-zksync-v2-docs
diff --git a/.github/workflows/deploy-prod.yml b/.github/workflows/deploy-prod.yml
@@ -34,11 +34,6 @@ jobs:
           RUDDERSTACK_WRITE_KEY: "${{ secrets.RUDDERSTACK_WRITE_KEY }}"
           RUDDERSTACK_DATA_PLANE_URL: "${{ secrets.RUDDERSTACK_DATA_PLANE_URL }}"
 
-
-      - name: "Copy 404"
-        run: |
-          cp ./dist/docs/404.html ./dist/404.html
-
       - uses: matter-labs/action-hosting-deploy@main
         with:
           repoToken: "${{ secrets.GITHUB_TOKEN }}"

diff --git a/.github/workflows/deploy-staging.yml b/.github/workflows/deploy-staging.yml
@@ -28,13 +28,9 @@ jobs:
         run: |
           yarn set version 3.1.1
           yarn install
-      - name: "Deploy target: rinkeby-staging"
+      - name: "Deploy target: staging"
         run: yarn run docs:build
 
-      - name: "Copy 404"
-        run: |
-          cp ./dist/docs/404.html ./dist/404.html
-
       - uses: matter-labs/action-hosting-deploy@main
         with:
           repoToken: "${{ secrets.GITHUB_TOKEN }}"

diff --git a/.gitignore b/.gitignore
@@ -15,6 +15,7 @@ node_modules/
 
 # production
 build
+!docs/build
 dist
 .idea
 lib

diff --git a/.prettierignore b/.prettierignore
@@ -1,5 +1,4 @@
 node_modules
 .github
 .idea
-public
-/docs/README.md
+public
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# zkSync Era Documentation
+# zkSync Documentation
 
 [![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/matter-labs/zksync-web-v2-docs?color=%234E529A&label=changelog)](CHANGELOG.md)
 [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/matter-labs/zksync-wallet/blob/master/LICENSE-MIT) [![GitHub license](https://img.shields.io/badge/license-Apache%202-blue)](https://github.com/matter-labs/zksync-wallet/blob/master/LICENSE-MIT)
@@ -9,7 +9,7 @@
 > 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 Era Docs](https://era.zksync.io/docs) contain up-to-date information about **zkSync Era**.
+[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.
 
@@ -72,25 +72,25 @@ If `lint:spell` doesn't recognize a word, and you’re sure that it’s correct,
 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 `docs/dev/tutorials` folder.
+- 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 `docs/.vuepress/sidebar/en.ts` file, add the tutorial inside this block:
+- In the `.vuepress/sidebar/en.ts` file, add the tutorial inside this block:
 
 ```js
 {
   text: "Tutorials",
   link: "/dev/tutorials",
   children: [
-        "/dev/tutorials/cross-chain-tutorial.md",
-        "/dev/tutorials/custom-aa-tutorial.md",
-        "/dev/tutorials/aa-daily-spend-limit.md",
-        "/dev/tutorials/custom-paymaster-tutorial.md",
+        "/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 `docs/assets/images` folder.
+- 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
@@ -125,4 +125,4 @@ Configuration in `.cSpell.json`:
     "name": "zksync", "path": "./cspell-zksync.txt"
   }
 ]
-```
+```
diff --git a/cspell-zksync.txt b/cspell-zksync.txt
@@ -4,6 +4,7 @@ zkweb
 zksync
 zkscan
 zkscrypto
+zkstack
 libzkscrypto
 pubkey
 pubdata
@@ -37,6 +38,8 @@ validator's
 CHAINID
 PREVRANDAO
 sepolia
+Boojum
+permissioned
 
 // Names
 Vyper
@@ -61,6 +64,7 @@ pepe
 Arweave
 Streamr
 dutterbutter
+zeek
 
 // Used libraries
 numberish
@@ -77,6 +81,133 @@ Eigen
 IPFS
 Nuxt
 viem
+Wagmi
+
+// docs restructure
+NVME
+OTLP
+rocksdb
+multivm
+Reinitializing
+sqlx
+rustc
+ROCKSDB
+librocksdb
+CUDA
+gcloud
+rustc
+unsynchronized
+rustc
+abda
+edaf
+impls
+hdcaa
+emilluta
+zkevm
+cicruit
+Cuda
+cuda
+Ankr
+DRPC
+reliabile
+Oflatest
+IDIA
+USRC
+Pythnet
+Pyth
+subql
+incentivized
+retreives
+Devs
+Ethersv
+satoshi
+Dappradar
+Zetta
+Zetta
+Plonky
+
+// NFT Marketplaces
+Kreatorland
+Tevaera
+ONFT
+Zonic
+
+// wallets
+Echoo
+Enkrypt
+Rabby
+Yasp
+
+// zkstack
+nocapture
+preds
+inttoptr
+syncvm
+preds
+syncvm
+nasm
+rodata
+ISZERO
+JUMPI
+ISZERO
+JUMPI
+ethir
+ptrtoint
+lshr
+preds
+inttoptr
+syncvm
+getu
+zext
+getu
+noprofile
+ptrtoint
+lshr
+syncvm
+umin
+nasm
+rodata
+iszero
+cccond
+ccret
+prodl
+prodeh
+interm
+prodm
+signv
+ashr
+noalias
+prode
+prodh
+Merklized
+reexecuted
+Arithmetization
+arithmetization
+satisfiability
+demultiplex
+Decommitments
+Decommittments
+decommitments
+decommittments
+Decommitment
+Decommittment
+decommitment
+decommittment
+Decommitter
+decommitter
+decommitting
+decommits
+Demuxer
+decommit
+Deduplicator
+Binop
+mathbb
+Invb
+REDC
+skept
+ECADD
+ECMUL
+
 
 // Used programming language words
 printf
@@ -99,6 +230,10 @@ porco
 rosso
 insize
 MLOAD
+psql
+jemalloc
+recid
+plux
 
 // ETC
 gitter
@@ -126,6 +261,7 @@ USDCUSD
 ETHUS
 USDCUS
 ETHUSD
+MCRN
 Arbitrum
 Adamantium
 Immunefi
@@ -135,6 +271,7 @@ Evmla
 UUPS
 Uups
 TLDR
+inversed
 
 // crypto events
 Edcon
@@ -168,3 +305,9 @@ mundo
 ISTN
 Zerion
 Maverik
+freezability
+predeloyed
+
+// testing ci
+Omnibtc
+Owlto
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,6 +15,7 @@ node_modules/ @@
     # production
     build
+    !docs/build
     dist
     .idea
     lib
@@ Expand Down @@