Skip to content

Commit b6bbef4

Browse files
authored
feat: switch docs into vocs (#1929)
Closes INT-4644, INT-4645, INT-4650, INT-4648 (links are checked automatically by vocs)
1 parent 335f0b3 commit b6bbef4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

66 files changed

+7746
-1921
lines changed

.github/workflows/lints.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ jobs:
2323

2424
- uses: codespell-project/actions-codespell@v2
2525
with:
26-
skip: Cargo.lock,./book/pnpm-lock.yaml,*.txt,./crates/toolchain/openvm/src/memcpy.s,./crates/toolchain/openvm/src/memset.s,./audits/*.pdf,./guest-libs/ruint/*
26+
skip: Cargo.lock,./docs/vocs/pnpm-lock.yaml,*.txt,./crates/toolchain/openvm/src/memcpy.s,./crates/toolchain/openvm/src/memset.s,./audits/*.pdf,./guest-libs/ruint/*
2727
ignore_words_file: .codespellignore
2828

2929
- uses: dtolnay/rust-toolchain@stable
Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
1-
name: Publish mdBook to Vercel
1+
name: Publish Vocs Docs to Vercel
22

33
on:
4+
pull_request:
5+
branches:
6+
- feat/new-execution
47
workflow_dispatch:
58
inputs:
69
branch:
@@ -18,40 +21,37 @@ jobs:
1821

1922
steps:
2023
- name: Checkout repository
21-
uses: actions/checkout@v4
24+
uses: actions/checkout@v5
2225
with:
2326
ref: ${{ github.event.inputs.branch }}
2427

25-
- name: Install Rust
26-
uses: dtolnay/rust-toolchain@stable
27-
- uses: Swatinem/rust-cache@v2
28+
- name: Setup pnpm
29+
uses: pnpm/action-setup@v4
2830
with:
29-
cache-on-failure: true
31+
version: 9.15.0
3032

31-
- name: Setup mdbook
32-
uses: peaceiris/actions-mdbook@v1
33+
- name: Setup Node.js
34+
uses: actions/setup-node@v4
3335
with:
34-
mdbook-version: "latest"
36+
node-version: 20
37+
cache: 'pnpm'
38+
cache-dependency-path: 'docs/vocs/pnpm-lock.yaml'
3539

36-
- name: Install mdbook plugins
40+
- name: Build docs
3741
run: |
38-
cargo install mdbook-katex mdbook-linkcheck mdbook-mermaid just
39-
40-
- name: Build the book
41-
run: |
42-
cd book
43-
mdbook build
42+
cd docs/vocs/
43+
pnpm install --frozen-lockfile && pnpm vercel-build
4444
4545
- name: Install Vercel CLI
4646
run: npm install -g vercel
4747

4848
- name: Deploy to Vercel
4949
env:
5050
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }} # Token stored in GitHub Secrets
51-
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID }}
51+
VERCEL_PROJECT_ID: ${{ secrets.VERCEL_VOCS_PROJECT_ID }}
5252
VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }}
5353
run: |
54-
cd book/book
54+
cd docs/vocs/
5555
mkdir .vercel
5656
echo "{\"projectId\":\"$VERCEL_PROJECT_ID\",\"orgId\":\"$VERCEL_ORG_ID\"}" > .vercel/project.json
57-
vercel --prod --token $VERCEL_TOKEN
57+
vercel --prod --token $VERCEL_TOKEN --yes

book/.gitignore

Lines changed: 0 additions & 2 deletions
This file was deleted.

book/.markdownlint.json

Lines changed: 0 additions & 20 deletions
This file was deleted.

book/Justfile

Lines changed: 0 additions & 50 deletions
This file was deleted.

book/book.toml

Lines changed: 0 additions & 10 deletions
This file was deleted.

book/cspell.json

Lines changed: 0 additions & 24 deletions
This file was deleted.

book/package.json

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)