Generate docs content to Pages

[humanagent]

Fixed SDK docs issues while doing docs deployment

• Preview

name: Deploy docs content to GitHub Pages

on:
  push:
    branches: ["main", "docs", "docs_build_v1"]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: macos-12
    steps:
      - uses: actions/checkout@v3

      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: 3.0

      - name: Cache Ruby gems
        uses: actions/cache@v2
        with:
          path: vendor/bundle
          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
          restore-keys: |
            ${{ runner.os }}-gems-

      - name: Install Jazzy
        run: |
          bundle config path vendor/bundle
          bundle add jazzy

      - name: Generate documentation
        run: bundle exec jazzy --output ./docs --theme=fullwidth

      - name: Setup Pages
        uses: actions/configure-pages@v3

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: "./docs"

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2

To run this locally:

gem install jazzy
jazzy --output ./docs --theme=fullwidth

[nplasterer]

Nice! Seems to be working. I'd suggest deleting the old docs deployment action so we don't have two running https://github.com/xmtp/xmtp-ios/blob/main/.github/workflows/build-docs.yml

[nplasterer]

I don't know enough about iOS development to know if this would be an issue cc @nakajima

[humanagent]

I'm trying to speed it up a bit. This file is caching jazzy and saving almost 1.5min. Doesn't have that much of an impact so i can delete it if can cause potential conflicts.

[nakajima]

Seems fine to me.

[nakajima]

Seems fine to me.