docs: simplify README, defer detail to the docs site #30
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
| # .github/workflows/pages.yml | |
| name: Docs Site | |
| on: | |
| push: | |
| branches: [main] | |
| # app.html is included because the docs screenshots are rendered from it — | |
| # without this a UI change would leave the published images stale. | |
| paths: ['site/**', 'components/tigo_server/web/app.html', '.github/workflows/pages.yml'] | |
| pull_request: | |
| paths: ['site/**', 'components/tigo_server/web/app.html', '.github/workflows/pages.yml'] | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| concurrency: | |
| group: pages | |
| # Don't cancel an in-flight production deploy — a cancelled Pages deploy does | |
| # not auto-retry and would leave the live site stale until a manual re-run. | |
| cancel-in-progress: false | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| defaults: | |
| run: | |
| working-directory: site | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: '22' | |
| cache: 'npm' | |
| cache-dependency-path: site/package-lock.json | |
| - run: npm ci | |
| # --only-shell: the headless shell is ~115 MB vs ~170 MB for full | |
| # Chromium, and nothing here needs a headed browser. | |
| - run: npx playwright install --with-deps chromium --only-shell | |
| - run: node --test test/*.test.mjs | |
| # `npm run build` runs screenshots/capture.mjs first, so the images are | |
| # always rendered from the app.html in this commit. | |
| - run: npm run build | |
| - uses: actions/configure-pages@v5 | |
| - uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'site/dist' | |
| deploy: | |
| needs: build | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deploy.outputs.page_url }} | |
| steps: | |
| - id: deploy | |
| uses: actions/deploy-pages@v4 |