docs: make the getting started guide work without a model provider API key (#2283)
16 days 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
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
docs(telemetry): the Data Collected list omitted the host hardware attributes
crates/telemetry/src/anonymous.rs::resource builds the telemetry
resource with five attributes beyond service.name/name:
service.version, service.instance.id, spicepod.id, host.cpu.count,
host.gpu.count and host.memory.bytes. The page — whose purpose is to
enumerate what leaves the host — listed only the first three. The
hardware attributes arrived in spiceai/spiceai#8483, first released
v1.11.0, so they are added to v1.11.x and later.
The instance-id formula also lost a separator: since
spiceai/spiceai#9321 (first released v2.0.0) the hash is
SHA256(hostname + ":" + spicepod_name), not the concatenation the
page describes. Corrected for v2.0.x and later; v1.11.x and older
document their own releases correctly.
Both source links pointed at blob/trunk with a line anchor, so every
snapshot linked today's code at a line that has since moved — L65 of
anonymous.rs is now a blank line inside resource(), and L32 of lib.rs
is a histogram-bucket comment rather than the metric definitions.
Each doc set now links its own release tag (vNext links the reviewed
trunk SHA), the identifier link spans the whole resource() function
at that ref, and the metrics link drops the stale line anchor.
a month ago