From c1285f271da9096b07c6b4ed90418e355880497f Mon Sep 17 00:00:00 2001 From: dh Date: Wed, 21 Jan 2026 23:16:08 +0100 Subject: [PATCH 1/3] Update documentation files to disable Liquid rendering - Added front matter to `llms-full.md` and `oauth-client-app-guide.md` to set `render_with_liquid` to false, ensuring proper rendering without Liquid templating. --- docs/llms-full.md | 4 ++++ docs/oauth-client-app-guide.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/llms-full.md b/docs/llms-full.md index d176a47..4d1f8ba 100644 --- a/docs/llms-full.md +++ b/docs/llms-full.md @@ -1,3 +1,7 @@ +--- +render_with_liquid: false +--- + # MindCache - Complete LLM Documentation > This document is optimized for LLMs to understand and work with MindCache. It contains comprehensive API documentation with extensive code examples. diff --git a/docs/oauth-client-app-guide.md b/docs/oauth-client-app-guide.md index 26c2e42..fd6a663 100644 --- a/docs/oauth-client-app-guide.md +++ b/docs/oauth-client-app-guide.md @@ -1,3 +1,7 @@ +--- +render_with_liquid: false +--- + # Building Apps with MindCache OAuth Create apps where users can "Sign in with MindCache" to get automatic cloud storage and sync. From 202f4112d5dc845a5f8a87225a3bb6fd97e2e0dc Mon Sep 17 00:00:00 2001 From: dh Date: Wed, 21 Jan 2026 23:17:43 +0100 Subject: [PATCH 2/3] Add documentation check job to GitHub Actions workflow - Introduced a new `docs-check` job in the `pr-validation.yml` workflow to build GitHub Pages using Jekyll. - The job runs only for non-draft pull requests, ensuring that documentation is validated before merging. - Added steps for checking out the code and building the documentation site, with success messages for clarity. --- .github/workflows/pr-validation.yml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml index 0dc7e21..5b16a8c 100644 --- a/.github/workflows/pr-validation.yml +++ b/.github/workflows/pr-validation.yml @@ -119,3 +119,22 @@ jobs: run: | cd packages/mindcache && pnpm pack && ls -lh *.tgz && rm *.tgz echo "✅ Package size check complete!" + + docs-check: + runs-on: ubuntu-latest + if: github.event.pull_request.draft == false + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: 📄 Build GitHub Pages (Jekyll) + uses: actions/jekyll-build-pages@v1 + with: + source: ./docs + destination: ./_site + + - name: ✅ Docs build passed + run: | + echo "🎉 GitHub Pages build successful!" + echo "No Liquid syntax errors found." From b62fe5a759f26256cf8f62c3285fb20f058a85b7 Mon Sep 17 00:00:00 2001 From: dh Date: Wed, 21 Jan 2026 23:20:57 +0100 Subject: [PATCH 3/3] Update CI workflows and documentation rendering - Enhanced the CI workflow in `ci.yml` to trigger on specific paths, ensuring relevant changes are validated. - Modified the `pr-validation.yml` workflow to include a new job for detecting changes in code and documentation, improving the validation process for pull requests. - Updated documentation files `llms-full.md` and `oauth-client-app-guide.md` to disable Liquid rendering, ensuring proper formatting for LLM consumption. --- .github/workflows/ci.yml | 14 ++++++++++++++ .github/workflows/pr-validation.yml | 30 ++++++++++++++++++++++++++--- docs/llms-full.md | 6 ++---- docs/oauth-client-app-guide.md | 6 ++---- 4 files changed, 45 insertions(+), 11 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 836fa04..6b840eb 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,8 +3,22 @@ name: CI on: push: branches: [ main, develop ] + paths: + - 'packages/**' + - 'pnpm-lock.yaml' + - 'package.json' + - 'tsconfig.json' + - 'turbo.json' + - '.github/workflows/ci.yml' pull_request: branches: [ main, develop ] + paths: + - 'packages/**' + - 'pnpm-lock.yaml' + - 'package.json' + - 'tsconfig.json' + - 'turbo.json' + - '.github/workflows/ci.yml' jobs: test: diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml index 5b16a8c..581f2e6 100644 --- a/.github/workflows/pr-validation.yml +++ b/.github/workflows/pr-validation.yml @@ -6,9 +6,31 @@ on: types: [opened, synchronize, reopened, ready_for_review] jobs: - validate: + changes: runs-on: ubuntu-latest if: github.event.pull_request.draft == false + outputs: + code: ${{ steps.filter.outputs.code }} + docs: ${{ steps.filter.outputs.docs }} + steps: + - uses: actions/checkout@v4 + - uses: dorny/paths-filter@v3 + id: filter + with: + filters: | + code: + - 'packages/**' + - 'pnpm-lock.yaml' + - 'package.json' + - 'tsconfig.json' + - 'turbo.json' + docs: + - 'docs/**' + + validate: + runs-on: ubuntu-latest + needs: changes + if: needs.changes.outputs.code == 'true' steps: - name: Checkout code @@ -76,7 +98,8 @@ jobs: size-check: runs-on: ubuntu-latest - if: github.event.pull_request.draft == false + needs: changes + if: needs.changes.outputs.code == 'true' steps: - name: Checkout code @@ -122,7 +145,8 @@ jobs: docs-check: runs-on: ubuntu-latest - if: github.event.pull_request.draft == false + needs: changes + if: needs.changes.outputs.docs == 'true' steps: - name: Checkout code diff --git a/docs/llms-full.md b/docs/llms-full.md index 4d1f8ba..0ea2146 100644 --- a/docs/llms-full.md +++ b/docs/llms-full.md @@ -1,7 +1,4 @@ ---- -render_with_liquid: false ---- - +{% raw %} # MindCache - Complete LLM Documentation > This document is optimized for LLMs to understand and work with MindCache. It contains comprehensive API documentation with extensive code examples. @@ -2483,4 +2480,5 @@ NEXT_PUBLIC_INSTANCE_ID=your-instance-id --- *This documentation is optimized for LLM consumption. For human-readable documentation with interactive examples, visit [mindcache.dev](https://mindcache.dev).* +{% endraw %} diff --git a/docs/oauth-client-app-guide.md b/docs/oauth-client-app-guide.md index fd6a663..73294bf 100644 --- a/docs/oauth-client-app-guide.md +++ b/docs/oauth-client-app-guide.md @@ -1,7 +1,4 @@ ---- -render_with_liquid: false ---- - +{% raw %} # Building Apps with MindCache OAuth Create apps where users can "Sign in with MindCache" to get automatic cloud storage and sync. @@ -261,3 +258,4 @@ oauth.tokenProvider // Token function for MindCache **"CORS error"**: Check that you're using the correct API URLs for your environment. **"Session expired"**: The refresh token (30 days) expired. User needs to sign in again. +{% endraw %}