From 2e14edbbb24969d3b6ae1454798dec13d91e4e79 Mon Sep 17 00:00:00 2001 From: Samuel Burnham <45365069+samuelburnham@users.noreply.github.com> Date: Thu, 29 Aug 2024 14:47:58 -0400 Subject: [PATCH] Add website config --- .github/workflows/ci.yml | 6 +++++- .github/workflows/publish.yml | 22 ++++++++++++++++++++++ CNAME | 1 + book.toml | 4 ++-- src/02-setup.md | 4 ++-- 5 files changed, 32 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/publish.yml create mode 100644 CNAME diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 2c47109..21cdb48 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -17,4 +17,8 @@ jobs: uses: taiki-e/install-action@mdbook - name: Install mdbook-linkcheck uses: taiki-e/install-action@mdbook-linkcheck - - run: mdbook build \ No newline at end of file + - run: mdbook build + + # Check documentation links aren't broken + link-checker: + uses: argumentcomputer/ci-workflows/.github/workflows/links-check.yml@main diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..82c328c --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,22 @@ +name: Deploy user manual to GitHub Pages + +on: + push: + branches: + - main + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Install mdBook + run: cargo install mdbook + - name: Build the book + run: mdbook build + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./book + publish_branch: gh-pages diff --git a/CNAME b/CNAME new file mode 100644 index 0000000..b3f7853 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +docs.argument.xyz diff --git a/book.toml b/book.toml index a6d812d..d5577bd 100644 --- a/book.toml +++ b/book.toml @@ -1,12 +1,12 @@ [book] -authors = ["Lurk Lab"] +authors = ["Argument"] language = "en" multilingual = false src = "src" title = "Lurk User Manual" [output.html] -git-repository-url = "https://github.com/lurk-lang/user-manual" +git-repository-url = "https://github.com/argumentcomputer/user-manual" [output.linkcheck] follow-web-links = true diff --git a/src/02-setup.md b/src/02-setup.md index 7aae702..a402288 100644 --- a/src/02-setup.md +++ b/src/02-setup.md @@ -2,7 +2,7 @@ ## Setup -Clone the [lurk-rs](https://github.com/lurk-lab/lurk-rs) repository and run the following command inside its folder: +Clone the [lurk-rs](https://github.com/argumentcomputer/lurk-rs) repository and run the following command inside its folder: ``` $ cargo install --path . @@ -21,5 +21,5 @@ More detailed information on the features of the `lurk` binary will be presented ## Support -In case of any trouble, we are available on our [Zulip server](https://zulip.lurk-lab.com). +In case of any trouble, we are available on our [Zulip server](https://zulip.argument.xyz). Feel free to join us, start threads and ask questions.