From b5d73a54bf0e6d147e3b5f32d3ab822280ea3363 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 20 Jun 2025 14:02:32 -0700 Subject: [PATCH] **docs(readme): fix demo link and update GitHub Actions workflow versions** ### Changes: - **README.md**: Corrected the relative path for the live demo link to `examples/demo.html`. - **github-pages.yml**: - Updated GitHub Actions steps to their latest versions: - `actions/checkout@v4` - `actions/configure-pages@v4` - `actions/upload-pages-artifact@v3` - `actions/deploy-pages@v4` - Ensured compatibility with the latest versions of the workflow actions. ### Purpose: Fixed a broken link in the README for better user accessibility to the demo. Updated workflow actions in `github-pages.yml` to leverage the latest performances and features. --- .github/workflows/github-pages.yml | 14 +++++++------- README.md | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index d0a9b0d4..40f548a2 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -18,16 +18,16 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3 - + uses: actions/checkout@v4 + - name: Setup Pages - uses: actions/configure-pages@v3 - + uses: actions/configure-pages@v4 + - name: Upload artifact - uses: actions/upload-pages-artifact@v2 + uses: actions/upload-pages-artifact@v3 with: path: './examples' # Upload the examples directory - + - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v2 + uses: actions/deploy-pages@v4 diff --git a/README.md b/README.md index 4e76ae08..20110220 100644 --- a/README.md +++ b/README.md @@ -955,7 +955,7 @@ Before deploying, make sure to configure the appropriate environment variables i The repository includes a comprehensive demo that showcases Brainy's main features: - `examples/demo.html` - A single demo page with animations demonstrating Brainy's features. - - **[Try the live demo](https://soulcraft.github.io/brainy/demo.html)** - Check out the interactive demo on GitHub Pages + - **[Try the live demo](https://soulcraft.github.io/brainy/examples/demo.html)** - Check out the interactive demo on GitHub Pages - Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details) The demo showcases: