Skip to content

Update crate description to focus on developer use case #5

Update crate description to focus on developer use case

Update crate description to focus on developer use case #5

Workflow file for this run

name: Deploy Docs
on:
push:
branches: [mainline]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Rust
uses: dtolnay/rust-toolchain@stable
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: 'latest'
- name: Build rustdoc
run: cargo doc --no-deps --document-private-items
- name: Build mdBook
run: mdbook build docs
- name: Merge documentation
run: |
# Use mdBook as the main site
mkdir -p target/site
cp -r target/book/* target/site/
# Add rustdoc under /api/
mkdir -p target/site/api
cp -r target/doc/* target/site/api/
# Add redirect for API docs
echo '<meta http-equiv="refresh" content="0;url=keyspace_tracker/index.html">' > target/site/api/index.html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: target/site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4