diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 89b4d5a..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,61 +0,0 @@ -name: Docs - -on: - push: - branches: - - main - paths: - - docs/** - - .github/workflows/docs.yml - pull_request: - paths: - - docs/** - - .github/workflows/docs.yml - -concurrency: - # Deploys to a single live site, so let an in-flight deploy finish rather - # than cancelling it half-way; PRs (build-only) are still cancellable. - group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} - cancel-in-progress: ${{ github.event_name == 'pull_request' }} - -# Read-only by default; the deploy job opts into exactly what Pages needs. -permissions: - contents: read - -jobs: - build: - runs-on: ubuntu-24.04 - timeout-minutes: 15 - steps: - - uses: actions/checkout@v4 - - uses: actions/setup-python@v5 - with: - python-version: "3.11" - - name: Install MkDocs - run: pip install mkdocs-material==9.5.49 - # --strict turns broken internal links and bad nav entries into build - # failures, so a PR that moves a doc cannot silently ship a dead site. - - name: Build site - run: mkdocs build -f docs/mkdocs.yml --strict - - name: Upload Pages artifact - if: github.ref == 'refs/heads/main' && github.event_name == 'push' - uses: actions/upload-pages-artifact@v3 - with: - path: docs/site - - deploy: - # Only main deploys; PRs stop at the build check above. - if: github.ref == 'refs/heads/main' && github.event_name == 'push' - needs: build - runs-on: ubuntu-24.04 - timeout-minutes: 15 - permissions: - pages: write # deploy to GitHub Pages - id-token: write # verify the deployment originates from this workflow - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c23cfb9..d4e5072 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,6 +1,6 @@ site_name: lance-context site_description: A storage engine for AI data — agent memory and RL training data — built on Lance -site_url: https://lance-format.github.io/lance-context/ +site_url: https://lance.org/integrations/context/ docs_dir: src repo_name: lance-format/lance-context @@ -57,23 +57,8 @@ markdown_extensions: plugins: - search + - awesome-pages -nav: - - Home: index.md - - Guide: - - Quickstart: guide/quickstart.md - - Rollouts (RolloutDB): guide/rollouts.md - - Storage backends: guide/storage.md - - Development: guide/development.md - - Specs: - - Rollout schema: specs/rollout-schema-design.md - - Rollout deployment: specs/rollout-deployment.md - - Blob streaming: specs/rollout-blob-streaming.md - - Datagen checkpoints: specs/datagen-checkpoint-schema.md - - Design: - - Partitioned namespace: design/partitioned-namespace.md - - Auto-dream: design/auto-dream.md - - Using the datagen store: design/using-datagen-store.md extra: social: diff --git a/docs/src/.pages b/docs/src/.pages new file mode 100644 index 0000000..95e7970 --- /dev/null +++ b/docs/src/.pages @@ -0,0 +1,5 @@ +nav: + - Home: index.md + - Guide: guide + - Specs: specs + - Design: design diff --git a/docs/src/design/.pages b/docs/src/design/.pages new file mode 100644 index 0000000..604b087 --- /dev/null +++ b/docs/src/design/.pages @@ -0,0 +1,4 @@ +nav: + - Partitioned namespace: partitioned-namespace.md + - Auto-dream: auto-dream.md + - Using the datagen store: using-datagen-store.md diff --git a/docs/src/guide/.pages b/docs/src/guide/.pages new file mode 100644 index 0000000..473fa98 --- /dev/null +++ b/docs/src/guide/.pages @@ -0,0 +1,5 @@ +nav: + - Quickstart: quickstart.md + - Rollouts (RolloutDB): rollouts.md + - Storage backends: storage.md + - Development: development.md diff --git a/docs/src/specs/.pages b/docs/src/specs/.pages new file mode 100644 index 0000000..01551b2 --- /dev/null +++ b/docs/src/specs/.pages @@ -0,0 +1,5 @@ +nav: + - Rollout schema: rollout-schema-design.md + - Rollout deployment: rollout-deployment.md + - Blob streaming: rollout-blob-streaming.md + - Datagen checkpoints: datagen-checkpoint-schema.md