Skip to content

Commit

Permalink
Fixed broken links. CI pipeline for PRs. (#29)
Browse files Browse the repository at this point in the history
* Fixed broken links and added ci workflow for PRs.

* Added install step to build
  • Loading branch information
kubaplas authored Feb 5, 2024
1 parent 77059fd commit 3ec731d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 3 deletions.
20 changes: 20 additions & 0 deletions .github/workflows/pr.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docusaurus/docs/backends/01-what-is-a-backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/backends/03-casper.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 "[email protected]"
git config --local user.name "GitHub Action"
Expand Down

0 comments on commit 3ec731d

Please sign in to comment.