diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..de90888 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,71 @@ +name: Deploy docs to GitHub Pages + +on: + push: + branches: + - main + workflow_dispatch: + +env: + UV_VERSION: "0.7.13" + PYTHON_VERSION: "3.11" + DISABLE_MKDOCS_2_WARNING: "true" + +permissions: + contents: read + pages: write + id-token: write + +concurrency: + group: pages + cancel-in-progress: false + +jobs: + build: + name: Build site + runs-on: ubuntu-latest + steps: + - name: Check out repository + uses: actions/checkout@v6 + with: + # Required by mkdocs-git-revision-date-localized-plugin so it can + # walk the full history when computing per-page modification dates. + fetch-depth: 0 + + - name: Install Python + uses: actions/setup-python@v6 + with: + python-version: ${{ env.PYTHON_VERSION }} + + - name: Install uv + uses: astral-sh/setup-uv@v6 + with: + version: ${{ env.UV_VERSION }} + enable-cache: true + python-version: ${{ env.PYTHON_VERSION }} + cache-dependency-glob: | + pyproject.toml + uv.lock + + - name: Install docs dependencies + run: uv sync --group docs + + - name: Build site (strict) + run: uv run mkdocs build --strict + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: site + + deploy: + name: Deploy to GitHub Pages + needs: build + runs-on: ubuntu-latest + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Deploy + id: deployment + uses: actions/deploy-pages@v4 diff --git a/AGENTS.md b/AGENTS.md index e4bebd9..9f2627b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -96,7 +96,7 @@ Full reference, generated from docstrings, is at `docs/api/`. | Artifact | Purpose | |---|---| -| [`llms.txt`](https://docs.redisvl.com/projects/sql-redis/llms.txt) | Auto-generated flat index of every doc page with one-line summaries. Built by `mkdocs-llmstxt` at deploy time. Good for in-context injection. | +| [`llms.txt`](https://redis-developer.github.io/sql-redis/llms.txt) | Auto-generated flat index of every doc page with one-line summaries. Built by `mkdocs-llmstxt` at deploy time. Good for in-context injection. | | [`docs/api/`](docs/api/) | mkdocstrings reference for every public symbol, generated from Google-style docstrings. Source of truth for method signatures. | | [`docs/user_guide/how_to_guides/`](docs/user_guide/how_to_guides/) | Task-oriented recipes (vector search, GEO, dates, async, parameters). | | [`docs/concepts/`](docs/concepts/) | Why-style explanation: architecture, parameter substitution, schema-aware translation. | @@ -105,9 +105,10 @@ Full reference, generated from docstrings, is at `docs/api/`. ## Hub context sql-redis sits in the [Redis AI Hub](https://redis.io/ai-hub/) under the -*Experimental* tier as "SQL for Redis". Public docs URL: -[`docs.redisvl.com/projects/sql-redis/`](https://docs.redisvl.com/projects/sql-redis/). -The hub's docs standards (Diataxis layout, docstring-driven API reference, -AI-agent affordances) are documented at +*Experimental* tier as "SQL for Redis". Published docs: +[`redis-developer.github.io/sql-redis/`](https://redis-developer.github.io/sql-redis/) +(GitHub Pages, deployed by `.github/workflows/docs.yml` on every push to +`main`). The hub's docs standards (Diataxis layout, docstring-driven API +reference, AI-agent affordances) are documented at [`HUB_DOCS_STANDARDS.md`](https://github.com/redis/docs/blob/main/HUB_DOCS_STANDARDS.md) in the hub repo. diff --git a/README.md b/README.md index 3ed0e8c..eae10e2 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,18 @@ -# sql-redis +
SQL on top of RediSearch and RedisVL indexes
+