Add doc generation to CI and readme badges

.github/workflows/ci.yml

@@ -65,3 +65,34 @@ jobs:
         run: |
           AFL_I_DONT_CARE_ABOUT_MISSING_CRASHES=1 \
           cargo afl fuzz -i tests/afl-fuzz/in -o tests/afl-fuzz/out -V 60 target/debug/zksync_vm2_afl_fuzz
+
+  document:
+    # needs:
+    #  - build_and_test
+    # if: github.event_name == 'push' && github.ref_type == 'branch'
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+
+      - name: Build docs
+        run: |
+          cargo clean --doc && \
+          cargo rustdoc -p zksync_vm2_interface && \
+          cargo rustdoc -p zksync_vm2
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: target/doc
+          single-commit: true

README.md

@@ -1,5 +1,8 @@
 # High-Performance ZKsync Era VM (EraVM)
 
+[![Build Status](https://github.com/matter-labs/vm2/actions/workflows/ci.yml/badge.svg)](https://github.com/matter-labs/vm2/actions)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/License-MIT%2FApache--2.0-blue)](https://github.com/matter-labs/vm2#license)
+
 A high-performance rewrite of the out-of-circuit VM for ZKsync Era (aka EraVM).
 
 See [Era docs](https://github.com/matter-labs/zksync-era/tree/main/docs/specs/zk_evm) for the VM overview and formal specification.

crates/vm2-interface/README.md

@@ -1,5 +1,11 @@
 # Stable Interface for ZKsync Era VM
 
+[![Build Status](https://github.com/matter-labs/vm2/actions/workflows/ci.yml/badge.svg)](https://github.com/matter-labs/vm2/actions)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/License-MIT%2FApache--2.0-blue)](https://github.com/matter-labs/vm2#license)
+
+**Documentation:**
+[![crate docs (main)](https://img.shields.io/badge/main-yellow.svg?label=docs)](https://matter-labs.github.io/vm2/zksync_vm2_interface/)
+
 This library provides a stable interface for EraVM. It defines an interface for tracers that will never change but may be extended.
 
 ## License

crates/vm2/README.md

@@ -1,5 +1,11 @@
 # High-Performance ZKsync Era VM
 
+[![Build Status](https://github.com/matter-labs/vm2/actions/workflows/ci.yml/badge.svg)](https://github.com/matter-labs/vm2/actions)
+[![License: MIT OR Apache-2.0](https://img.shields.io/badge/License-MIT%2FApache--2.0-blue)](https://github.com/matter-labs/vm2#license)
+
+**Documentation:**
+[![crate docs (main)](https://img.shields.io/badge/main-yellow.svg?label=docs)](https://matter-labs.github.io/vm2/zksync_vm2/)
+
 A high-performance rewrite of the out-of-circuit VM for ZKsync Era.
 
 ## License