### Changes:
- **`demo/simplified-augmentations-gh-pages.js`**:
- Added a new demo script showcasing simplified augmentations for GitHub Pages.
- Includes examples for static and streaming data processing, WebSocket support, and dynamic augmentation loading.
- **`README.md`**:
- Updated the demo link to point directly to `https://soulcraft-research.github.io/brainy/`.
- **`.github/workflows/deploy-demo.yml`**:
- Enhanced the deployment workflow to include the `simplified-augmentations-gh-pages.js` file as the GitHub Pages demo entry point.
- Added steps to copy and prepare required `dist` files during the build process.
- **`demo/index.html`**:
- Dynamically adjusted the import path for the Brainy library to support both local and CDN environments.
- Reformatted code for readability and alignment with deployment needs.
### Purpose:
Introduced a tailored demonstration script for GitHub Pages to highlight Brainy's streamlined augmentation features. Enhanced the deployment pipeline for better integration and seamless live demo experience.
### Changes:
- **rollup.config.js**:
- Merged and reformatted `nodeBuiltins` definition for cleaner code.
- Updated `input` path from `examples/browser_compatible_exports.ts` to `demo/browser_compatible_exports.ts`.
- Reformatted `replace` plugin configuration for better readability.
- **.github/workflows/deploy-demo.yml**:
- Updated deployment folder from `examples` to `demo`.
- **Renamed**:
- `examples/browser_compatible_exports.ts` → `demo/browser_compatible_exports.ts`.
- **scripts/generate-version.js**:
- Removed unnecessary semicolons for consistent formatting.
### Purpose:
Aligned folder structure by migrating from `examples` to `demo` for uniformity and better organization. Improved code readability and formatting across configurations and scripts.
### Changes:
- **deploy-demo.yml**:
- Added `contents: write` permissions to ensure the workflow can access repository content during operations.
- Used `${{ secrets.GITHUB_TOKEN }}` for authentication in the deployment step.
- **package.json**:
- Removed the `deploy:demo` script and its `gh-pages` dependency to clean up unused scripts and dependencies.
### Purpose:
Enhanced the deploy workflow by explicitly defining required permissions and securely managing authentication. Simplified the configuration by removing outdated scripts and dependencies.
### Changes:
- **deploy-demo.yml**: Removed an unnecessary blank line in the dependency installation step.
### Purpose:
Refined the workflow file to improve readability and maintain consistency in formatting. This is a minor housekeeping change with no impact on functionality.
### Changes:
- **README.md**: Added a "Live Demo" section with a direct link to the interactive GitHub Pages demo.
- **deploy-demo.yml**: Modified dependency installation step to use `npm install --legacy-peer-deps` for compatibility.
### Purpose:
Improved documentation by providing direct access to the live demo for better user engagement. Updated the deploy workflow to ensure successful dependency resolution during the setup process.
### Changes:
- Introduced `deploy-demo.yml` workflow in `.github/workflows/` to automate deployment to GitHub Pages:
- Triggers on `main` branch pushes and manual workflow dispatch.
- Includes steps for project setup, build, and deployment using `JamesIves/github-pages-deploy-action`.
- Added `examples/CNAME` with custom domain `www.soulcraft.com`.
### Purpose:
Streamlined and automated the deployment of the demo to GitHub Pages, ensuring efficient updates. Configured a custom domain for better branding and accessibility of the live demo.
### Changes:
- Removed `github-pages.yml` GitHub Actions workflow file.
- Updated `README.md`:
- Added documentation for `npm run deploy:demo` to deploy the demo to GitHub Pages.
- Updated the live demo link to reflect the repository's namespace change.
- Added `gh-pages` dependency (v6.3.0) in `package.json`.
- Introduced `deploy:demo` script in `package.json` for demo deployment.
### Purpose:
Streamlined the demo deployment process by removing the dedicated GitHub Pages workflow and replacing it with a manual deployment script (`npm run deploy:demo`). This enhances developer control while maintaining simplicity in deploying updates to the live demo.
### Changes:
- **github-pages.yml**:
- Downgraded `actions/upload-pages-artifact` from `v3` to `v2`.
### Purpose:
Reverted to `v2` of the `upload-pages-artifact` action to maintain compatibility with existing workflows or address potential issues introduced in `v3`.
### Changes:
- Reformatted `README.md` for enhanced readability:
- Applied line wrapping to long paragraphs and bullet points.
- Adjusted spacing and indentation for consistent formatting.
- Resolved issues with inconsistent code snippet alignments and metadata formatting.
### Purpose:
Improved the readability and maintainability of the README by standardizing formatting and wrapping long lines. These changes ensure better clarity for users exploring the documentation.
### Changes:
- **github-pages.yml**:
- Updated `actions/upload-pages-artifact` from `v3` to `v4`.
### Purpose:
Ensured compatibility with the latest version of the `upload-pages-artifact` action to leverage improvements and maintain long-term support.
### 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.
### Changes:
- Introduced a new `github-pages.yml` workflow in `.github/workflows/`.
- Configured the workflow to:
- Trigger on pushes to the `main` branch.
- Deploy files from the `./examples` directory to GitHub Pages.
- Utilize Actions such as `checkout`, `configure-pages`, `upload-pages-artifact`, and `deploy-pages`.
- Set up necessary permissions for deploying to GitHub Pages.
### Purpose:
Added an automated GitHub Actions workflow to streamline the deployment of content to GitHub Pages. This ensures a consistent and efficient process for updating the demo or documentation hosted online.
Deleted augmentation pipeline examples and `.releaserc.json`, streamlining the repository by eliminating redundant example implementations and release automation files.
