feat(website): publish agent discovery documents for spiceai.org (#2319)
* feat(website): publish agent discovery documents for spiceai.org
Implement the isitagentready.com checks that apply to a static docs site:
- Serve each page as Markdown to requests that prefer text/markdown
(functions/_middleware.js, using the files the llms-txt plugin now writes)
- Send RFC 8288 Link headers on the homepage
- Publish an RFC 9727 API catalog and /openapi.json for the runtime HTTP API
- Publish the spiceai/skills v2.3.2 skills with an Agent Skills Discovery index
- Publish an ARD manifest at /.well-known/ard.json and ai-catalog.json
- Register WebMCP tools (search_docs, get_page_markdown)
- Declare Content Signals in robots.txt
* fix(website): download the agent skills at a pinned commit, not a tag
A tag can be moved to different content, and the index digests describe only the
downloaded bytes. Pin skillsCommit to the v2.3.2 release commit and reject an
archive of any other commit before publishing.
* fix(website): use the standard ARD media types for skills
A single SKILL.md is text/markdown; profile="urn:air:agent-skills" in the ARD
conformance definitions, not application/agent-skills+md. Drop the llms.txt entry,
whose plain text/markdown type ARD reads as a skill missing its profile.
* fix(website): read search result URLs with get_page_markdown on any deployment
search_docs returns canonical https://spiceai.org URLs, which get_page_markdown
rejected on preview and local deployments. Read the same path from the current
deployment instead. Also write the zero-width space regex as \u200b.
* fix(website): serve openapi.json with its OpenAPI media type, skip Functions for favicons
/openapi.json was served as application/json although the API catalog and Link
headers advertise application/vnd.oai.openapi+json. Root favicon requests invoked
the middleware; exclude them in _routes.json.
7 days ago
docs: update community Slack URL to https://spice.ai/slack (#1752)
5 months ago
Tweak font sizes
7 months ago
Rename Blog -> Releases (#1297)
* Rename Blog -> Releases
* Formatting
* Fix build errors
* Fix
* Add redirects
9 months ago
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
docs: Sync the cookbook page and recipe links with spiceai/cookbook (#2318)
* Sync the cookbook page with the current spiceai/cookbook recipes
List all 122 current recipes (up from 79) and leave out evals, llm-judge, and websearch, which the cookbook marks deprecated in v2.0+.
- Correct entries that pointed at the wrong recipe or described an old version: Results Caching linked the Caching Accelerator recipe, Nvidia NIM on Kubernetes linked the EC2 recipe, Hashed Partitioning now uses Cayenne, and Federated SQL Query no longer uses Dremio.
- Add the missing recipes, including Cayenne, async queries, native PostgreSQL/MySQL/MongoDB CDC, DynamoDB Streams, HTTP, Redshift, ScyllaDB, SMB, the catalog connectors, full-text search, distributed query, and Spice as an MCP server.
- Add Change Data Capture and Advanced Topics sections. Local Dataset Replication was tagged for no rendered section, so it never appeared.
- Show guides in Sample Applications and Guides instead of Security.
- Align Core Features with the cookbook's core scenarios and feature Cayenne as the data accelerator.
- Label recipes that need Spice.ai Enterprise.
- Remove forbidden words (enhance, leverage, utilize, robust) from section intros.
* Fix broken and stale cookbook recipe references across doc versions
Every version links to the recipes on cookbook trunk, so these corrections apply to each version that carries them.
- Query Federation: replace the walkthrough with the current Federated SQL Query recipe, which joins NYC taxi trips in S3 with taxi zones in PostgreSQL. The old walkthrough logged in to a demo Dremio, ran 'spice add spiceai/fed-demo' (that Spicepod no longer exists on Spicerack), and ran 'cd demo' twice. The new steps and output come from a run of the recipe on Spice v2.3.2.
- FAQ: the RAG recipe link (cookbook/tree/trunk/rag) never existed; link the RAG use-case page instead.
- Use cases: fix duckdb/accelerator/README and federation/README links that were missing the .md extension.
- PostgreSQL connector: link the connector recipe instead of the accelerator recipe, and fix 'configure Supabase a data connector'.
- ODBC connector: the recipe now connects to MySQL with the MariaDB driver, not Postgres.
- Glue catalog connector: its recipe configures the Glue Catalog Connector, not the Data Connector.
- Release notes: fix three recipe links that pointed at moved or malformed paths.
* Link docs pages to their cookbook recipes
49 cookbook recipes had no link from any docs page. Add a Cookbook section, or a bullet in an existing one, on the matching page in vNext and 2.3.x. Covered pages include CDC (PostgreSQL, MySQL, Aurora MySQL, MongoDB), the catalog connectors (DuckLake, MySQL, SQL Server, Unity Catalog, Databricks, Iceberg Hadoop, PostgreSQL CDC), acceleration (partitioning, snapshots, indexes, constraints, views, caching, cron refresh, dual-dataset registration), search, distributed query and async queries, MCP, LLM memory, text-to-SQL, the ai() function, models (OpenAI, DeepSeek, filesystem, xAI, NVIDIA NIM on Kubernetes), API keys, ADBC, JDBC, the SDKs, and Cloud Connect. The sidecar and microservice architecture partials, which every version shares, link their recipes too.
Related updates:
- The docs landing page lists Cayenne among the accelerators and links the Cayenne recipe.
- The Cayenne Transactions intro also covers tables configured for durable write-back, matching the section's own requirements.
- The FAQ says the cookbook has over 120 recipes, up from over 65.
v1.11 Documentation (#1296)
* Remove OTel ports from docs (#1270)
* Docs for Google (#1286)
Co-authored-by: Evgenii Khramkov <evgenii@spice.ai>
Co-authored-by: Luke Kim <80174+lukekim@users.noreply.github.com>
* Parameterized Queries docs (#1298)
* Paramterized Queries docs
* Formatting
* Add SMB and NFS Data Connector Docs (#1295)
* Add SMB & NFS Data Connector docs
* Fixes
* formatting
* Rename "params" key (#1300)
* Fix params (#1301)
* Update Dynamodb Authentication (#1304)
* Update Dynamodb Auth
* Update
* Cayenne: document cayenne_file_path and cayenne_metadata_dir (#1307)
* Update snapshots documentation (#1318)
* Update snapshots documentation
* Fix
* Docs for snapshots_reset_expiry_on_load (#1322)
* Minor fixes for DynamoDB (#1323)
* Minor fixes for DynamoDB
* Minor fix
* Update Distributed Query docs for v1.11 changes (#1326)
* Update Distributed Query docs for v1.11 changes
* Update website/docs/features/distributed-query/index.md
Co-authored-by: Jack Eadie <jack@spice.ai>
---------
Co-authored-by: Jack Eadie <jack@spice.ai>
* ScyllaDB Data Connector docs (#1325)
* Add Arrow Hash Index docs (#1324)
* Add Arrow Hash Index docs
* Formatting
* Add versioning support (#1308)
* Add versioning support
* Fix: empty versions array until release branches exist
* Enable versioned docs for release/1.11 branch
* Fix: resolve git refs with origin/ prefix for CI
* Fix: run git archive from repo root
* Fix: serve current docs at /docs, versioned docs at /docs/v1.11
* fix(versioning): only show unmaintained banner for versions outside maintenance window
* Update to 1
* feat(versioning): add enterprise support note on unmaintained version banner
* feat(versioning): add support for unreleased docs from trunk
- Current docs (trunk) now served at /docs/next with 'unreleased' banner
- Latest release branch served at /docs as the default
- Previous versions continue at /docs/v1.11, etc.
* Move to right
* feat(versioning): auto-detect release branches from git
- Script now auto-detects release/<major>.<minor> branches
- No manual VERSIONS array maintenance required
- Creating a new release branch automatically adds version to docs
* Fix
* fix(versioning): highest version is 'next', second highest is 'latest'
- v1.11.x (highest) → Next (unreleased) at /docs/next
- v1.10.x (second) → Latest (stable) at /docs
- Trunk docs available at /docs/trunk
- Previous versions at /docs/v1.9, etc.
* fix(versioning): warn on broken links for cross-version compatibility
Older release branches may contain absolute links to docs pages that
don't exist in all versions. Setting onBrokenLinks to 'warn' allows
the build to succeed while still reporting these issues.
* Fixes
* Fixes
* Update menu
* Improve SMB docs (#1328)
* Improve copilot instructions
* Improve SMB docs
---------
Co-authored-by: Phillip LeBlanc <phillip@spice.ai>
Co-authored-by: Jack Eadie <jack@spice.ai>
Co-authored-by: Evgenii Khramkov <evgenii@spice.ai>
Co-authored-by: Viktor Yershov <viktor@spice.ai>
Co-authored-by: Sergei Grebnov <sergei.grebnov@gmail.com>