Update project status and future usage vision documentation to reflec… #106
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Documentation | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| docs: | |
| name: Build Documentation | |
| runs-on: ubuntu-latest | |
| environment: ${{ github.ref == 'refs/heads/main' && 'github-pages' || null }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: recursive | |
| - name: Install Rust | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Cache dependencies | |
| uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.cargo/registry | |
| ~/.cargo/git | |
| target | |
| key: ${{ runner.os }}-docs-cargo-${{ hashFiles('**/Cargo.lock') }} | |
| - name: Build documentation | |
| run: | | |
| # Create directory structure for dual documentation | |
| mkdir -p target/doc-final/{cloud,embedded} | |
| # Build cloud/edge documentation | |
| cargo doc --features "std,tokio-runtime,tracing,metrics" --no-deps | |
| cp -r target/doc/* target/doc-final/cloud/ | |
| # Build embedded documentation | |
| cargo doc --no-default-features --features "embassy-runtime" --no-deps | |
| cp -r target/doc/* target/doc-final/embedded/ | |
| # Copy main index page | |
| cp docs/index.html target/doc-final/index.html | |
| - name: Setup Pages | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/configure-pages@v4 | |
| - name: Upload artifact | |
| if: github.ref == 'refs/heads/main' | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: ./target/doc-final | |
| - name: Deploy to GitHub Pages | |
| if: github.ref == 'refs/heads/main' | |
| id: deployment | |
| uses: actions/deploy-pages@v4 |