From 36092c4e421016abea2e706ea6845476a5538e3b Mon Sep 17 00:00:00 2001
From: DaniPopes <57450786+DaniPopes@users.noreply.github.com>
Date: Tue, 20 Feb 2024 21:15:54 +0100
Subject: [PATCH] feat: host documentation on GitHub Pages

---
 .github/workflows/test.yml | 25 +++++++++++++++++++++++++
 README.md                  |  5 +++++
 2 files changed, 30 insertions(+)

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index cb25172002e7..13e2d43670fa 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -91,6 +91,31 @@ jobs:
           SVM_TARGET_PLATFORM: ${{ matrix.svm_target_platform }}
         run: cargo nextest run ${{ matrix.flags }}
 
+  docs:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      contents: write
+      pages: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-on-failure: true
+      - run: cargo doc --workspace --all-features --no-deps --document-private-items
+        env:
+          RUSTDOCFLAGS:
+            --cfg docsrs --show-type-layout --generate-link-to-definition --enable-index-page
+            -Zunstable-options
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@v3
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: target/doc
+          force_orphan: true
+
   doctest:
     runs-on: ubuntu-latest
     timeout-minutes: 30
diff --git a/README.md b/README.md
index 8f205f13d922..a3be44ccd06f 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,11 @@
 [tg-support-badge]: https://img.shields.io/endpoint?color=neon&logo=telegram&label=support&style=flat-square&url=https%3A%2F%2Ftg.sumanjay.workers.dev%2Ffoundry_support
 [tg-support-url]: https://t.me/foundry_support
 
+**[Install](https://book.getfoundry.sh/getting-started/installation)**
+| [User Book](https://book.getfoundry.sh)
+| [Developer Docs](./docs)
+| [Crate Docs](https://foundry-rs.github.io/foundry/docs)
+
 **Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
 
 Foundry consists of: