diff --git a/.github/workflows/mdbook.yaml b/.github/workflows/mdbook.yaml new file mode 100644 index 0000000..7434dc0 --- /dev/null +++ b/.github/workflows/mdbook.yaml @@ -0,0 +1,47 @@ +# On Repository Settings > Pages > Build and deployment +# Set "Source" to GitHub Actions. +name: Documentation +on: + push: + branches: ["main"] + pull_request: + branches: ["main"] + +jobs: + mdbook_test: + name: Test mdBook Documentation builds + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install mdBook + run: | + cargo install mdbook --no-default-features --features search --vers "^0.4" --locked + - name: Test mdBook + run: mdbook test + + mdbook_publish: + if: ${{ github.event_name != 'pull_request' }} + needs: mdbook_test + permissions: + pages: write + contents: write + id-token: write + name: Publish mdBook to Github Pages + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Install mdBook + run: | + cargo install mdbook --no-default-features --features search --vers "^0.4" --locked + + - name: Build mdBook + run: mdbook build + + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + with: + path: book + - name: Deploy to Github Pages + uses: actions/deploy-pages@v4 diff --git a/.gitignore b/.gitignore index ea8c4bf..11e2b4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ /target +/book diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..095b5bb --- /dev/null +++ b/book.toml @@ -0,0 +1,5 @@ +[book] +authors = ["the rayhunter Authors"] +language = "en" +src = "doc" +title = "rayhunter Documentation" diff --git a/doc/SUMMARY.md b/doc/SUMMARY.md new file mode 100644 index 0000000..9bec737 --- /dev/null +++ b/doc/SUMMARY.md @@ -0,0 +1,4 @@ +# Summary + +- [Installation](./installation.md) +- [Supported Devices](./supported_devices.md) diff --git a/doc/installation.md b/doc/installation.md new file mode 100644 index 0000000..b743fda --- /dev/null +++ b/doc/installation.md @@ -0,0 +1 @@ +# Chapter 1 diff --git a/doc/supported_devices.md b/doc/supported_devices.md new file mode 100644 index 0000000..c4fdb21 --- /dev/null +++ b/doc/supported_devices.md @@ -0,0 +1,4 @@ +# Supported devices + +- Orbic RC400L +- TPLink M7350 HW rev. 3, 5, 9