From 0e6d1a90f357f6d303f8e8dba54f687e6c0079b9 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Mon, 10 Oct 2022 11:07:16 -0700 Subject: [PATCH 1/2] Use docs for name of workflow and directory --- .github/workflows/{book.yaml => docs.yaml} | 4 ++-- {book => docs}/book.toml | 0 {book => docs}/src/SUMMARY.md | 0 {book => docs}/src/bounty.md | 0 {book => docs}/src/bounty/0.md | 0 {book => docs}/src/bounty/1.md | 0 {book => docs}/src/bounty/2.md | 0 {book => docs}/src/faq.md | 0 {book => docs}/src/hunting.md | 0 {book => docs}/src/theory.md | 0 justfile | 8 ++++---- 11 files changed, 6 insertions(+), 6 deletions(-) rename .github/workflows/{book.yaml => docs.yaml} (97%) rename {book => docs}/book.toml (100%) rename {book => docs}/src/SUMMARY.md (100%) rename {book => docs}/src/bounty.md (100%) rename {book => docs}/src/bounty/0.md (100%) rename {book => docs}/src/bounty/1.md (100%) rename {book => docs}/src/bounty/2.md (100%) rename {book => docs}/src/faq.md (100%) rename {book => docs}/src/hunting.md (100%) rename {book => docs}/src/theory.md (100%) diff --git a/.github/workflows/book.yaml b/.github/workflows/docs.yaml similarity index 97% rename from .github/workflows/book.yaml rename to .github/workflows/docs.yaml index 9562d89b5f..efaf7bd5d6 100644 --- a/.github/workflows/book.yaml +++ b/.github/workflows/docs.yaml @@ -1,4 +1,4 @@ -name: Book +name: Docs on: pull_request: @@ -13,7 +13,7 @@ defaults: shell: bash jobs: - book: + docs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3.0.0 diff --git a/book/book.toml b/docs/book.toml similarity index 100% rename from book/book.toml rename to docs/book.toml diff --git a/book/src/SUMMARY.md b/docs/src/SUMMARY.md similarity index 100% rename from book/src/SUMMARY.md rename to docs/src/SUMMARY.md diff --git a/book/src/bounty.md b/docs/src/bounty.md similarity index 100% rename from book/src/bounty.md rename to docs/src/bounty.md diff --git a/book/src/bounty/0.md b/docs/src/bounty/0.md similarity index 100% rename from book/src/bounty/0.md rename to docs/src/bounty/0.md diff --git a/book/src/bounty/1.md b/docs/src/bounty/1.md similarity index 100% rename from book/src/bounty/1.md rename to docs/src/bounty/1.md diff --git a/book/src/bounty/2.md b/docs/src/bounty/2.md similarity index 100% rename from book/src/bounty/2.md rename to docs/src/bounty/2.md diff --git a/book/src/faq.md b/docs/src/faq.md similarity index 100% rename from book/src/faq.md rename to docs/src/faq.md diff --git a/book/src/hunting.md b/docs/src/hunting.md similarity index 100% rename from book/src/hunting.md rename to docs/src/hunting.md diff --git a/book/src/theory.md b/docs/src/theory.md similarity index 100% rename from book/src/theory.md rename to docs/src/theory.md diff --git a/justfile b/justfile index 60b7c53142..a0e3ea4df4 100644 --- a/justfile +++ b/justfile @@ -115,8 +115,8 @@ flamegraph: benchmark dir=`git branch --show-current`: ./bin/benchmark '{{dir}}' -serve-book: - mdbook serve book --open +serve-docs: + mdbook serve docs --open -build-book: - mdbook build book +build-docs: + mdbook build docs From 50fb76f36b9c3ea71de2886360164b643972a0e6 Mon Sep 17 00:00:00 2001 From: Casey Rodarmor Date: Mon, 10 Oct 2022 11:08:47 -0700 Subject: [PATCH 2/2] Fix workflow --- .github/workflows/docs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index efaf7bd5d6..589349c0e2 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -31,7 +31,7 @@ jobs: chmod +x mdbook-linkcheck pwd >> $GITHUB_PATH - - run: mdbook build book + - run: mdbook build docs - name: Deploy Pages uses: peaceiris/actions-gh-pages@v3 @@ -39,4 +39,4 @@ jobs: with: github_token: ${{secrets.GITHUB_TOKEN}} publish_branch: gh-pages - publish_dir: book/build/html + publish_dir: docs/build/html