From 3ec731d2457b0e4a3790d1e981890638e4d7196c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kuba=20P=C5=82askonka?= Date: Mon, 5 Feb 2024 12:45:56 +0100 Subject: [PATCH] Fixed broken links. CI pipeline for PRs. (#29) * Fixed broken links and added ci workflow for PRs. * Added install step to build --- .github/workflows/pr.yml | 20 +++++++++++++++++++ .../docs/backends/01-what-is-a-backend.md | 2 +- docusaurus/docs/backends/03-casper.md | 2 +- justfile | 2 +- 4 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/pr.yml diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 000000000..2f8506c38 --- /dev/null +++ b/.github/workflows/pr.yml @@ -0,0 +1,20 @@ +name: ci-docs + +on: + pull_request: + branches: + - master + +jobs: + build: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + with: + fetch-depth: 0 + - uses: actions/setup-node@v3 + with: + node-version: 16 + - uses: extractions/setup-just@v1 + - name: Build + run: just build diff --git a/docusaurus/docs/backends/01-what-is-a-backend.md b/docusaurus/docs/backends/01-what-is-a-backend.md index 8083bd597..b815aa88a 100644 --- a/docusaurus/docs/backends/01-what-is-a-backend.md +++ b/docusaurus/docs/backends/01-what-is-a-backend.md @@ -5,7 +5,7 @@ sidebar_position: 1 # What is a backend? You can think of a backend as a target platform for your smart contract. -This can be a piece of code allowing you to quickly check your code - like [OdraVM](02-mock-vm.md), +This can be a piece of code allowing you to quickly check your code - like [OdraVM](02-odra-vm.md), a complete virtual machine, spinning up a blockchain for you - like [CasperVM](03-casper.md), or even a real blockchain - when using [Livenet backend](03-casper.md). diff --git a/docusaurus/docs/backends/03-casper.md b/docusaurus/docs/backends/03-casper.md index 7d6513258..f5f7aea03 100644 --- a/docusaurus/docs/backends/03-casper.md +++ b/docusaurus/docs/backends/03-casper.md @@ -226,7 +226,7 @@ You have to build it using your SDK. ## Execution -First thing Odra does with your code, is similar to the one used in [OdraVM](02-mock-vm.md) - +First thing Odra does with your code, is similar to the one used in [OdraVM](02-odra-vm.md) - a list of entrypoints is generated, thanks to the `#[odra::module]` macro. ```mermaid diff --git a/justfile b/justfile index 90d7b7ed8..4d76e9aac 100644 --- a/justfile +++ b/justfile @@ -2,6 +2,7 @@ install: cd docusaurus && npm install build: + just install cd docusaurus && npm run build rm -rf docs cp -r docusaurus/build docs @@ -19,7 +20,6 @@ docs-new-version version: cd docusaurus && npm run docusaurus docs:version {{version}} ci-build-and-commit: - just install just build git config --local user.email "action@github.com" git config --local user.name "GitHub Action"