-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/main' into gprusak-consensus-pla…
…ybook
- Loading branch information
Showing
211 changed files
with
743 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| name: Deploy core docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - "main" | ||
| tags: | ||
| - "core-v*.*.*" | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/deploy-core-docs.yml' | ||
| pull_request: | ||
| paths: | ||
| - 'docs/**' | ||
| - '.github/workflows/deploy-core-docs.yml' | ||
| workflow_dispatch: | ||
| inputs: | ||
| ref: | ||
| description: "Branch, tag or commit to deploy the core docs. If empty, use the ref that triggered the workflow." | ||
| required: false | ||
| default: "" | ||
| version: | ||
| type: string | ||
| description: "Version of the documentation to deploy" | ||
| required: false | ||
| default: "latest" | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
|
|
||
| deploy-core-docs: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| env: | ||
| DOCS_DIR: 'docs' | ||
| PROJECT: 'core' | ||
| ENABLE_TESTS: false | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | ||
| with: | ||
| ref: ${{ inputs.ref || '' }} | ||
|
|
||
| - name: Extract version from tag | ||
| if: startsWith(github.ref, 'refs/tags/') | ||
| id: extract-version | ||
| shell: 'bash -ex {0}' | ||
| run: | | ||
| TAG="${{ github.ref_name }}" | ||
| VERSION="${TAG#*-}" | ||
| echo "version=${VERSION}" >> "${GITHUB_OUTPUT}" | ||
| - name: Deploy core docs | ||
| uses: matter-labs/deploy-mdbooks@77856145362bf23834f2e54a44a928790c4bee7c # v1 | ||
| with: | ||
| version: ${{ inputs.version || steps.extract-version.outputs.version || github.ref_name }} | ||
| docs-dir: ${{ env.DOCS_DIR }} | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| enable-tests: ${{ env.ENABLE_TESTS }} | ||
| project: ${{ env.PROJECT }} | ||
| deploy: ${{ github.event_name != 'pull_request' }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| name: Deploy prover docs | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - "main" | ||
| tags: | ||
| - "prover-v*.*.*" | ||
| paths: | ||
| - 'prover/docs/**' | ||
| - '.github/workflows/deploy-prover-docs.yml' | ||
| pull_request: | ||
| paths: | ||
| - 'prover/docs/**' | ||
| - '.github/workflows/deploy-prover-docs.yml' | ||
| workflow_dispatch: | ||
| inputs: | ||
| ref: | ||
| description: "Branch, tag or commit to deploy the prover docs. If empty, use the ref that triggered the workflow." | ||
| required: false | ||
| default: "" | ||
| version: | ||
| type: string | ||
| description: "Version of the documentation to deploy" | ||
| required: false | ||
| default: "latest" | ||
|
|
||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
|
|
||
| jobs: | ||
|
|
||
| deploy-prover-docs: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write | ||
| env: | ||
| DOCS_DIR: 'prover/docs' | ||
| PROJECT: 'prover' | ||
| ENABLE_TESTS: false | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 | ||
| with: | ||
| ref: ${{ inputs.ref || '' }} | ||
|
|
||
| - name: Extract version from tag | ||
| if: startsWith(github.ref, 'refs/tags/') | ||
| id: extract-version | ||
| shell: 'bash -ex {0}' | ||
| run: | | ||
| TAG="${{ github.ref_name }}" | ||
| VERSION="${TAG#*-}" | ||
| echo "version=${VERSION}" >> "${GITHUB_OUTPUT}" | ||
| - name: Deploy prover docs | ||
| uses: matter-labs/deploy-mdbooks@77856145362bf23834f2e54a44a928790c4bee7c # v1 | ||
| with: | ||
| version: ${{ inputs.version || steps.extract-version.outputs.version || github.ref_name }} | ||
| docs-dir: ${{ env.DOCS_DIR }} | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| enable-tests: ${{ env.ENABLE_TESTS }} | ||
| project: ${{ env.PROJECT }} | ||
| deploy: ${{ github.event_name != 'pull_request' }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| book |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| [book] | ||
| authors = ["ZKsync team"] | ||
| language = "en" | ||
| multilingual = false | ||
| src = "src" | ||
| title = "ZKsync Era Documentation" | ||
|
|
||
| [output.html] | ||
| smart-punctuation = true | ||
| mathjax-support = true | ||
| git-repository-url = "https://github.com/matter-labs/zksync-era/tree/main/docs" | ||
| edit-url-template = "https://github.com/matter-labs/zksync-era/tree/main/docs/{path}" | ||
| additional-js = ["js/version-box.js", "js/mermaid-init.js"] | ||
| additional-css = ["css/version-box.css"] | ||
|
|
||
| [output.html.playground] | ||
| editable = true | ||
| line-numbers = true | ||
|
|
||
| [output.html.search] | ||
| limit-results = 20 | ||
| use-boolean-and = true | ||
| boost-title = 2 | ||
| boost-hierarchy = 2 | ||
| boost-paragraph = 1 | ||
| expand = true | ||
| heading-split-level = 2 | ||
|
|
||
| [preprocessor] | ||
|
|
||
| [preprocessor.mermaid] | ||
| command = "mdbook-mermaid" |
Oops, something went wrong.