Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Improve documentation formatting for clarity and consistency (#1389)
* Refine documentation across various sections for clarity and consistency
- Updated descriptions in datasets, models, runtime, and views documentation to enhance readability and precision.
- Improved explanations regarding retry mechanisms and refresh attempts in acceleration settings.
- Clarified the purpose and functionality of the `WITH` clause in SQL documentation.
- Enhanced troubleshooting guidance with detailed common issues and solutions for dataset loading, query performance, and AI chat results.
- Revised use case descriptions for agentic apps, edge AI, federated MCP server, object-store AI engine, and more to improve clarity and impact.
- Streamlined language throughout the documentation to ensure consistency and better user understanding.
* Improve documentation formatting for clarity and consistency across multiple sections
* Apply suggestion from @lukekim
* Update documentation links for consistency and clarity across multiple sections
7 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
docs(models): the chat-completion override list did not match OPENAI_DEFAULT_PARAM_KEYS
`tools` was dropped from the OpenAI request-body auto-defaults in
spiceai/spiceai#8725 (first released v1.11.0); since then a `tools`
value in a model's `params` is read only as Spice's tool-group
selector (`extract_secret!(params, "tools")` -> `SpiceToolsOptions`),
never as a default for OpenAI's `tools` request field. Remove the row
from v1.11.x onward; it stays correct in v1.10.x and older.
`reasoning_effort` has been in `OPENAI_DEFAULT_PARAM_KEYS` since
before v1.5.0 and was never listed — add it to every doc set.
`prompt_cache_key` joined the set at v2.0.0 and is already documented
in this page's Prompt Caching section — add it to the list for v2.0.x
and later so the enumeration matches the code.
a month ago
Improve documentation formatting for clarity and consistency (#1389)
* Refine documentation across various sections for clarity and consistency
- Updated descriptions in datasets, models, runtime, and views documentation to enhance readability and precision.
- Improved explanations regarding retry mechanisms and refresh attempts in acceleration settings.
- Clarified the purpose and functionality of the `WITH` clause in SQL documentation.
- Enhanced troubleshooting guidance with detailed common issues and solutions for dataset loading, query performance, and AI chat results.
- Revised use case descriptions for agentic apps, edge AI, federated MCP server, object-store AI engine, and more to improve clarity and impact.
- Streamlined language throughout the documentation to ensure consistency and better user understanding.
* Improve documentation formatting for clarity and consistency across multiple sections
* Apply suggestion from @lukekim
* Update documentation links for consistency and clarity across multiple sections
7 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago