diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index cb25172002e74..1012e65483c7f 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -91,6 +91,33 @@ 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 + with: + submodules: recursive + - 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 -D warnings --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 8f205f13d9222..a3be44ccd06fa 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: