From 51f7a957443670b8622e11531557fbd2d179f9de Mon Sep 17 00:00:00 2001
From: Caleb Foust <cfoust@sqweebloid.com>
Date: Tue, 31 Oct 2023 17:07:04 -0400
Subject: [PATCH] feat: add docs

---
 .github/workflows/docs.yml | 38 ++++++++++++++++++++++++++++++++++++++
 docs/.gitignore            |  1 +
 docs/book.toml             |  6 ++++++
 docs/src/SUMMARY.md        |  3 +++
 docs/src/chapter_1.md      |  1 +
 5 files changed, 49 insertions(+)
 create mode 100644 .github/workflows/docs.yml
 create mode 100644 docs/.gitignore
 create mode 100644 docs/book.toml
 create mode 100644 docs/src/SUMMARY.md
 create mode 100644 docs/src/chapter_1.md

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 00000000..bfdb4a9a
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,38 @@
+name: Deploy
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # To push a branch 
+      pages: write  # To push to a GitHub Pages site
+      id-token: write # To update the deployment status
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Install latest mdbook
+        run: |
+          tag=$(curl 'https://api.github.com/repos/rust-lang/mdbook/releases/latest' | jq -r '.tag_name')
+          url="https://github.com/rust-lang/mdbook/releases/download/${tag}/mdbook-${tag}-x86_64-unknown-linux-gnu.tar.gz"
+          mkdir mdbook
+          curl -sSL $url | tar -xz --directory=./mdbook
+          echo `pwd`/mdbook >> $GITHUB_PATH
+      - name: Build Book
+        run: |
+          cd docs
+          mdbook build
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          # Upload entire repository
+          path: 'docs/book'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 00000000..7585238e
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/docs/book.toml b/docs/book.toml
new file mode 100644
index 00000000..fcd975b7
--- /dev/null
+++ b/docs/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Caleb Foust"]
+language = "en"
+multilingual = false
+src = "src"
+title = "cy documentation"
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
new file mode 100644
index 00000000..7390c828
--- /dev/null
+++ b/docs/src/SUMMARY.md
@@ -0,0 +1,3 @@
+# Summary
+
+- [Chapter 1](./chapter_1.md)
diff --git a/docs/src/chapter_1.md b/docs/src/chapter_1.md
new file mode 100644
index 00000000..b743fda3
--- /dev/null
+++ b/docs/src/chapter_1.md
@@ -0,0 +1 @@
+# Chapter 1