Skip to content

Commit

Permalink
feat: Add website config (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
samuelburnham authored Aug 29, 2024
1 parent 445ba7a commit da4649c
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 6 deletions.
6 changes: 5 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
- run: mdbook build

# Check documentation links aren't broken
link-checker:
uses: argumentcomputer/ci-workflows/.github/workflows/links-check.yml@main
22 changes: 22 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
docs.argument.xyz
docs.argument.xyz
4 changes: 2 additions & 2 deletions book.toml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions src/02-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 .
Expand All @@ -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.

0 comments on commit da4649c

Please sign in to comment.