docs: refresh the claims that no longer match the code - #633
Merged
Conversation
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.



The documentation carries claims that no longer match the code. This corrects sixty-one of them across twenty-seven files. Every claim was checked against the repository before it was changed, and accurate history was deliberately left alone: sentences like "listed since 0.9.59" or "shipped since 0.9.60" are still true and are untouched.
What was wrong, by weight:
API_DOCS.mdannounced version 0.11.0 and listed thirteen engines, missing libSQL, DuckDB and Cassandra. Its storage example also used a collection key,queryHistory, that STORAGE_COLLECTIONS does not define, so a client copying it wrote a key nothing reads. The rate-limit table omitted the three storage routes that share the query bucket.ARCHITECTURE.mdsaid fourteen database backends where the SHIPPED record it cites carries seventeen type ids.SECURITY.mdsaid six fields are encrypted. connection-secrets.ts marks seven, and the list of what stays readable was incomplete, which is the kind of gap a security review acts on.AGENT.mdgave three different model counts (twelve, ten) against the twenty-eight in measured-profiles.json, and said nine engines cannot be read by a run where the number is fourteen.FEATURES.mdlisted four agent workflows where AgentRunWorkflowType defines five, and quoted single budget ceilings that are now set per workflow.AGENT_DEMO.mdtold a presenter that only two engines provide a read-only statement path. DuckDB implements it too, so the correct number is three.docs/providers/anddocs/llms/.The roster count in
docs/llms/setup.mdanddocs/llms/methodology.mdis not touched here; #632 already fixes it.Verification: the documentation guard tests pass (api-docs-types, agent-documentation, distribution-check, marketplace-copy: 238 pass, 0 fail; security-check and generate-channel-showcase: 51 pass, 0 fail). The helm chart tests fail identically on main in this environment because the chart dependency is not vendored, so they are unrelated to this change.
One commit per file, so a reviewer can read each correction next to the file it belongs to.