docs: low-severity fixes from the docs deep review - #505
Merged
Conversation
…r and recipe pages Wrong model id: the NVIDIA reranker default was written `nnvidia/...`, which is not a valid model id if copy-pasted. Template leaks from cloned provider pages: the NVIDIA overview told readers to configure the Cohere models, and the Databricks overview told them to configure OpenAI, shipped the OpenAI RAG illustration, and carried two broken possessives. All 25 provider overview pages were checked; those were the only two. Stale and missing model information: added embed-v4.0 to the Cohere multimodal list, which the page's own example already used; documented base_url on the Mistral full-parameter samples, matching the OpenAI ones. OctoAI: the pages carried a deprecation banner but still read as working walkthroughs. Every module method has returned a shutdown error server-side since v1.25.22, v1.26.8, and v1.27.1, so the samples are now marked as a record. Version wording is normalized to the house forms: a capability that was introduced and backported reads "Added in vX, and backported to vA, vB"; a changed default also states what earlier releases on those lines used. Also: a self-referencing link in the Voyage AI further-reading list, two Colab badges missing the blob/main segment, a Jupyter kernel error published as expected output, a deprecated vectorizer_config call, duplicate sidebar positions and a mislabeled category, and the remaining em dashes.
…or, and stale gRPC support Two snippets could not be copy-pasted. The IsNull example in the GraphQL filter reference was missing a closing paren and two braces, so it would not parse; all 14 code blocks on that page were checked for balance and it was the only one. The gRPC page's docker-compose block opened with a four-backtick fence and an invalid info string, so the page rendered a literal ```yaml line as content. gRPC client support was documented as Python and TypeScript only, with others "in the near future". Java and C# have first-class gRPC; the Go client uses it for batch imports and offers gRPC search through its experimental API only, so Go is described separately rather than claimed at parity. The hybrid search page linked to search-operators#variables-2, which lands on nearText's Variables section, not hybrid's. That page has six identically titled Variables headings, so the ordinal anchors are positional and shift whenever a heading moves. The link now targets the uniquely named fusion-algorithms section instead of a more accurate ordinal. The cross-references tutorial had a TypeScript source imported but never rendered, so the tab was simply absent; the import path was also extensionless. The Spark connector tutorial ended on a removed v3 client call. Em dashes removed across the search partition.
…lf-contradicting statements The Java and C# pages both required Weaviate 1.33.0. Both are wrong: the C# client's shipped library asserts a minimum of 1.32.0, and the Java client README says v1.32. The identical wrong sentence on both pages was a copy-paste. The Go page claimed compatibility with Go 1.16, roughly ten releases stale. It now derives the requirement from the go directive for the client version the site actually pins, so it stays true as that pin moves. Three names for one line in the Java get-started example: the prose said Ollama, the code called text2vecTransformers, and the comment said Contextionary. The source now uses text2vecOllama, matching the prose and the Python and TypeScript equivalents. That file is CI-executed; the lane already runs Ollama and pulls nomic-embed-text, and a sibling snippet uses the same call. Concepts said the client libraries in all languages support all API functions, which this repo contradicts elsewhere. It now says coverage varies by language and points at the client pages, rather than enumerating gaps that would go stale. The client list also omitted C#, and the vector index list omitted two index types, so it now links to the indexing page instead of enumerating. Also: the Java async client reference pointed at the retired pre-v6 class and package; a shell env assignment used a hyphen instead of an equals sign, twice, so Docker silently set the wrong variable; a demo table row shipped a "tbd" placeholder and another had the wrong modality; a flat-index link pointed at the inverted-index page; and the compression table said RQ was HNSW-only.
…rameter names, and missing reference Three things break when copy-pasted: the EKS helm upgrade ended on a dangling line continuation so the shell hangs, a second one was found in the 1.25 migration guide, the backup module was named gcs-backup when the module id is backup-gcs, and the MUVERA parameter was documented as repetition when the real name is repetitions, contradicted by the page's own tested sample. Undocumented reference content operators can hit: six environment variables (the hybrid result floor, the three CORS settings, and the three backup chunking overrides) with their defaults and the releases they arrived in, and the six reserved property-name suffixes that cause a hard validation error with nothing in the docs to explain it. The SQ compression page imported TypeScript code and rendered none of it. Two sections now have TypeScript tabs; the third has no such snippet, and since all three tab sets share a group id, a reader who picked TypeScript would silently have been served Python there, so that section says so explicitly. The SQ options source turned out to be a Binary Quantization copy-paste, and both SQ sources passed a cache option that the TypeScript client's sq helper does not accept, so neither would have compiled. Also: HNSW_STARTUP_WAIT_FOR_VECTOR_CACHE is deprecated and was not marked so while its neighbour was; the combined module example used an environment variable core no longer reads; embedded XDG paths are used verbatim rather than having a subdirectory appended; two Go tabs were tagged as bash and a curl tab as Python; language-agnostic prose used Python-only parameter spellings; the tenant status vocabulary was the deprecated HOT/COLD; the MCP hybrid tool's filters argument was undocumented; the spellcheck module linked to the NER page; client versions moved out of prose into install commands; and HFresh is now mentioned on the compression guide, since it is the default for free clusters.
…hed token limit The ColModernVBERT query token limit read 8,092, a transposition. The model's own tokenizer_config.json gives model_max_length 8192. It renders on two pages through a shared include. The AWS Bedrock page listed 21 model IDs that had gone stale. Core detects model families by substring, so newer models already work; the list is replaced with that explanation and a pointer to the live AWS list, so it cannot rot again. Also: a duplicated 'Vectorizer parameters' heading merged, default markers added to three model lists that had none, a Reranker section added to two provider index pages whose reranker page existed but was unreachable, and the v1.33+ opt-out variable for API-based modules documented alongside the older opt-in.
A duplicated-word footer ('multimodal embedding embeddings models') appears in
eight provider pages, a duplicated verb, a repeated 'Dataricks' typo, and
'Chose' for 'Choose' across three Transformers pages.
The Databricks pages told readers to provide an API key in several places.
Databricks uses a personal access token, which the pages' own header tables
already say. The custom-image page also named a folder the Dockerfile beside it
does not use.
33 em dashes replaced, each with the punctuation the sentence wants rather than a mechanical substitution. Eight of these were never filed by the review, which is the argument for the CI lint tracked separately. Client library version numbers removed from prose in five places. Where a version was load-bearing the sentence was rewritten to say the same thing without a number that rots. Also: the keyword-search page wrote the tokenizer as GSE, but the config value is lowercase gse and the uppercase form is a validation error; and a link to an env-var anchor was miscased, which fixes one of only two broken anchors in the build.
An 'Example full response' block was wrapped so that it was not valid JSON. The sample code prints each object separately, so an array would show output the code never produces; the block keeps the two objects and the label now matches, following the form the sibling quickstarts already use. Also: a card reused the icon of the card above it, another carried a literal tab in its icon string, and six em dashes are replaced.
…nd unreachable pages Two Go tabs were tagged as Python, so Go rendered with Python highlighting. They are now goraw rather than go: the go formatter strips tabs and flattens a full package-main program to column 0, which would have traded a highlighting bug for an indentation one. Three module pages pinned a contextionary image tag that appears in no live source. The tag used by weaviate core's compose files and by docs CI is used instead. Four module pages existed in the sidebar but were unreachable from the index body, and a bullet pointed at an anchor that was never defined.
…ntly wrong tab The concepts page described gRPC as a 'very small scale' addition 'as of May 2023'. It is default-on and carries most search and batch traffic. Rewritten without a new dated snapshot, and stating client coverage non-uniformly, since Go reaches gRPC search only through its experimental API. The custom-vectors install section had no C# tab while the query section below it does. Tab sets sharing a group id fall back to the first tab, so a reader who had selected C# was silently shown Python. Also: a malformed table row, a placeholder fence with no opening, a Go placeholder fenced as TypeScript, a link fragment pointing nowhere, an undocumented constructor parameter, two empty headings, an orphaned include, and a note that the boost page is Python-only.
…fix typos Seventeen imports left over from a migration that replaced screenshots with iframes were referencing assets no page rendered. One of them was a downtime warning. It was never rendered on this page, and it is no longer true for RBAC-enabled clusters, which manage users at runtime, so rendering it would have told readers that routine key rotation costs downtime. The import is removed and the now-unreferenced include deleted. The database settings table omitted DEFAULT_VECTOR_INDEX even though the Optimization profile section is entirely about which index becomes the default. The new row deliberately states no single value, because for Cloud there isn't one: it points at the profile and the note explains the mapping. Also an invalid JSON response block, and 'Select you' for 'your' twice.
Ivan asked for these two files to be left as they were. Restores docs/deploy/migration/weaviate-1-30.md and weaviate-1-25.md to their pre-review state. The findings behind them stay tracked: the removed REST endpoints (deploy-rest-004, deploy-rest-005) and the observation that the REINDEX_MAP_TO_BLOCKMAX workflow is inert on v1.38.0+ (board df1f6185).
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
docs(model-providers): fix structure, model lists, and a wrong published token limit
docs(model-providers): copy-editing across provider pages
docs(tutorials): fix invalid JSON, a duplicate card icon, and em dashes
docs(modules,connections): fix Go tab rendering, a stale image tag, and unreachable pages
…ector config The note on the `object` data type claimed absolutely that `object` and `object[]` properties are not vectorized. That conflicts with config-refs/indexing/vector-index.mdx, which documents that non-text types, including `object`, are vectorized when explicitly listed as source properties. Core confirms the docs page was wrong. In usecases/modulecomponents/vectorizer/object_texts.go the default switch handles only `string` and `[]string`; everything else falls through to a no-op. A second switch, guarded by `hasSourceProperties`, adds `map[string]any` and `[]map[string]any`, which are passed through `marshalValue` (json.Marshal, with a fmt.Sprintf fallback) and inserted into the vectorized corpus. So a listed object property is vectorized as its JSON representation. The sentence also conflated two independent mechanisms behind a single clause: vectorization and inverted-index storage. The inverted-index half was correct. Split them so each can be stated accurately, and align the wording and vocabulary with vector-index.mdx, which owns this topic. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DzkwXqkMC6agu8oGNswh2b
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
docs(cloud): remove dead imports, add the missing default-index row, fix typos
The "Python clients" section stated when embedded support landed in the Python v3 client (v3.15.4 on Linux, v3.21.0 on macOS). That client has been removed, so the fact describes software that no longer exists, and the client version numbers violate the house rule against client library versions in prose. Replace it with the current story: embedded support ships inside the Python client, with no separate package, which is the counterpart to the TypeScript section immediately below where the embedded client IS a separate package. The Weaviate server requirement (v1.23.7 or later) is kept. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DzkwXqkMC6agu8oGNswh2b
docs: assorted one-line defects, plus a stale gRPC section and a silently wrong tab
docs: house-style sweep across reference and concepts pages
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Infrastructure as Code | View in Orca | ||
| SAST | View in Orca | ||
| Secrets | View in Orca | ||
| Vulnerabilities | View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
Applies low-severity documentation corrections across Weaviate guides, references, examples, and Cloud documentation.
Changes:
- Corrects terminology, links, formatting, examples, and version guidance.
- Adds missing language tabs, provider references, configuration details, and Cloud defaults.
- Updates tested code snippets and removes obsolete imports/includes.
Reviewed changes
Copilot reviewed 141 out of 154 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
docs/weaviate/tutorials/tokenization.md |
Improves punctuation. |
docs/weaviate/tutorials/tls-ssl.mdx |
Updates house style. |
docs/weaviate/tutorials/spark-connector.md |
Fixes links and updates query example. |
docs/weaviate/tutorials/rbac.mdx |
Improves punctuation. |
docs/weaviate/tutorials/quick-tour-of-weaviate.mdx |
Revises response example. |
docs/weaviate/tutorials/index.mdx |
Fixes copy and card icons. |
docs/weaviate/tutorials/cross-references.mdx |
Adds TypeScript example and fixes links. |
docs/weaviate/starter-guides/managing-resources/indexing.mdx |
Improves punctuation. |
docs/weaviate/starter-guides/managing-resources/index.md |
Expands RQ index compatibility. |
docs/weaviate/starter-guides/custom-vectors.mdx |
Adds C# installation guidance. |
docs/weaviate/search/similarity.md |
Applies house-style edits. |
docs/weaviate/search/rerank.md |
Revises Boost guidance. |
docs/weaviate/search/query-profile.md |
Improves punctuation. |
docs/weaviate/search/hybrid.md |
Fixes link and prose. |
docs/weaviate/search/generative.md |
Fixes language, typo, and Java marker. |
docs/weaviate/search/filters.md |
Applies house-style edits. |
docs/weaviate/search/boost.md |
Clarifies client support and prose. |
docs/weaviate/search/bm25.md |
Applies house-style edits. |
docs/weaviate/recipes/weaviate_embeddings_service.md |
Fixes Colab URL. |
docs/weaviate/recipes/rag_titan-text-express-v1_bedrock.md |
Updates Colab URL and Python API. |
docs/weaviate/recipes/multi-vector-colipali-rag.md |
Removes stray notebook output. |
docs/weaviate/recipes.mdx |
Corrects introductory copy. |
docs/weaviate/more-resources/performance.md |
Updates vector-index coverage. |
docs/weaviate/more-resources/faq.md |
Applies house style. |
docs/weaviate/more-resources/example-use-cases.md |
Corrects modality and NER description. |
docs/weaviate/more-resources/example-datasets.md |
Fixes Docker environment arguments. |
docs/weaviate/modules/sum-transformers.md |
Updates Contextionary image. |
docs/weaviate/modules/spellcheck.md |
Updates Contextionary image. |
docs/weaviate/modules/ner-transformers.md |
Updates Contextionary image. |
docs/weaviate/modules/index.md |
Fixes links and adds module entries. |
docs/weaviate/model-providers/voyageai/reranker.md |
Fixes integration copy. |
docs/weaviate/model-providers/voyageai/embeddings.md |
Corrects reranker link. |
docs/weaviate/model-providers/transformers/reranker.md |
Corrects “choose” wording. |
docs/weaviate/model-providers/transformers/index.md |
Adds reranker section. |
docs/weaviate/model-providers/transformers/embeddings.md |
Fixes copy and punctuation. |
docs/weaviate/model-providers/transformers/embeddings-multimodal.md |
Corrects “choose” wording. |
docs/weaviate/model-providers/transformers/embeddings-multimodal-custom-image.md |
Corrects model-folder instructions. |
docs/weaviate/model-providers/transformers/embeddings-custom-image.md |
Fixes grammar. |
docs/weaviate/model-providers/openai/generative.md |
Clarifies versioned defaults. |
docs/weaviate/model-providers/octoai/_includes/octoai_deprecation.md |
Expands shutdown guidance. |
docs/weaviate/model-providers/nvidia/reranker.md |
Fixes model ID and copy. |
docs/weaviate/model-providers/nvidia/index.md |
Corrects provider name. |
docs/weaviate/model-providers/nvidia/generative.md |
Fixes integration copy. |
docs/weaviate/model-providers/nvidia/embeddings.md |
Fixes integration copy. |
docs/weaviate/model-providers/model2vec/_category_.json |
Corrects category metadata. |
docs/weaviate/model-providers/kubeai/index.md |
Fixes duplicated verb. |
docs/weaviate/model-providers/kubeai/_category_.json |
Normalizes category metadata. |
docs/weaviate/model-providers/jinaai/reranker.md |
Clarifies server default. |
docs/weaviate/model-providers/jinaai/index.md |
Adds reranker section. |
docs/weaviate/model-providers/jinaai/embeddings.md |
Clarifies default history. |
docs/weaviate/model-providers/jinaai/embeddings-multimodal.md |
Consolidates parameters and defaults. |
docs/weaviate/model-providers/jinaai/embeddings-colbert.md |
Marks server default. |
docs/weaviate/model-providers/index.md |
Documents API-module opt-out. |
docs/weaviate/model-providers/google/index.md |
Fixes credentials copy and heading. |
docs/weaviate/model-providers/google/embeddings.md |
Normalizes version wording. |
docs/weaviate/model-providers/google/embeddings-multimodal.md |
Documents default model. |
docs/weaviate/model-providers/friendliai/_category_.json |
Adjusts sidebar position. |
docs/weaviate/model-providers/digitalocean/embeddings.md |
Applies house style. |
docs/weaviate/model-providers/databricks/index.md |
Fixes branding and illustration. |
docs/weaviate/model-providers/databricks/generative.md |
Corrects token terminology. |
docs/weaviate/model-providers/databricks/embeddings.md |
Corrects token terminology and spacing. |
docs/weaviate/model-providers/contextualai/generative.md |
Normalizes default terminology. |
docs/weaviate/model-providers/cohere/reranker.md |
Clarifies default and fixes copy. |
docs/weaviate/model-providers/cohere/generative.md |
Clarifies versioned defaults. |
docs/weaviate/model-providers/cohere/embeddings.md |
Normalizes default terminology. |
docs/weaviate/model-providers/cohere/embeddings-multimodal.md |
Adds model and default labels. |
docs/weaviate/model-providers/aws/generative.md |
Replaces stale Bedrock model list. |
docs/weaviate/model-providers/anthropic/generative.md |
Documents default history. |
docs/weaviate/model-providers/_includes/provider.vectorizer.ts |
Adds Mistral base URL option. |
docs/weaviate/model-providers/_includes/provider.vectorizer.py |
Adds Mistral base URL option. |
docs/weaviate/model-providers/_includes/provider.generative.ts |
Adds Mistral base URL option. |
docs/weaviate/model-providers/_includes/provider.generative.py |
Adds Mistral base URL option. |
docs/weaviate/manage-objects/read-all-objects.mdx |
Removes stale client version wording. |
docs/weaviate/manage-objects/import.mdx |
Applies house style. |
docs/weaviate/manage-objects/create.mdx |
Fixes TypeScript import extension. |
docs/weaviate/manage-collections/multi-tenancy.mdx |
Corrects syntax highlighting. |
docs/weaviate/manage-collections/inverted-index.mdx |
Clarifies API parameter casing. |
docs/weaviate/connections/connect-query.mdx |
Applies house style. |
docs/weaviate/connections/connect-custom.mdx |
Removes stale client versions. |
docs/weaviate/connections/connect-cloud.mdx |
Corrects Go highlighting. |
docs/weaviate/configuration/rbac/manage-groups.mdx |
Removes stray fence. |
docs/weaviate/configuration/modules.md |
Updates API-module configuration. |
docs/weaviate/configuration/mcp-server.mdx |
Updates tenant states and filter docs. |
docs/weaviate/configuration/compression/sq-compression.md |
Adds TypeScript examples. |
docs/weaviate/configuration/compression/multi-vectors.md |
Corrects MUVERA parameters. |
docs/weaviate/configuration/authz-authn.md |
Applies house style. |
docs/weaviate/config-refs/indexing/vector-index.mdx |
Applies house-style edits. |
docs/weaviate/config-refs/indexing/inverted-index.mdx |
Applies house-style edits. |
docs/weaviate/config-refs/datatypes.md |
Clarifies object vectorization. |
docs/weaviate/config-refs/collections.mdx |
Documents reserved suffixes. |
docs/weaviate/concepts/vector-quantization.md |
Fixes flat-index link. |
docs/weaviate/concepts/storage.md |
Fixes environment-variable anchor. |
docs/weaviate/concepts/search/vector-search.md |
Applies house style. |
docs/weaviate/concepts/search/keyword-search.md |
Corrects gse casing. |
docs/weaviate/concepts/modules.md |
Corrects backup module name. |
docs/weaviate/concepts/interface.md |
Modernizes gRPC and client coverage. |
docs/weaviate/concepts/indexing/inverted-index.md |
Applies house-style edits. |
docs/weaviate/client-libraries/python/index.mdx |
Fixes compatibility wording and link. |
docs/weaviate/client-libraries/java/index.mdx |
Updates compatibility and link. |
docs/weaviate/client-libraries/index.mdx |
Removes prose version pins. |
docs/weaviate/client-libraries/go.md |
Updates Go requirement. |
docs/weaviate/client-libraries/csharp.mdx |
Updates compatibility requirement. |
docs/weaviate/client-libraries/_includes/feedback.mdx |
Removes orphaned feedback include. |
docs/weaviate/best-practices/index.md |
Updates async-client references. |
docs/weaviate/best-practices/code-generation.md |
Applies house style. |
docs/weaviate/api/index.mdx |
Removes prose version pins. |
docs/weaviate/api/grpc.md |
Updates client coverage and fence. |
docs/weaviate/api/graphql/get.md |
Adds operator reference links. |
docs/weaviate/api/graphql/filters.md |
Completes IsNull example. |
docs/deploy/production/aws/network-security.md |
Fixes copy and empty headings. |
docs/deploy/production/aws/hardening-eks.md |
Applies house style. |
docs/deploy/migration/weaviate-1-30.md |
Reverts migration endpoint guidance. |
docs/deploy/migration/weaviate-1-25.md |
Reverts downgrade version guidance. |
docs/deploy/installation-guides/spcs-integration.mdx |
Removes misplaced code. |
docs/deploy/installation-guides/embedded.md |
Updates embedded configuration details. |
docs/deploy/installation-guides/eks.md |
Fixes shell continuation. |
docs/deploy/configuration/replication.md |
Applies house style. |
docs/deploy/configuration/monitoring.md |
Applies house style. |
docs/deploy/configuration/export.md |
Applies house style. |
docs/deploy/configuration/env-vars/runtime-config.md |
Applies house style. |
docs/deploy/configuration/env-vars/index.md |
Adds missing environment variables. |
docs/deploy/configuration/backups.md |
Clarifies chunk configuration. |
docs/cloud/tools/collections-tool.mdx |
Fixes possessive typos. |
docs/cloud/quickstart.mdx |
Removes imports and revises response. |
docs/cloud/platform/users-and-organizations.mdx |
Applies house style. |
docs/cloud/platform/multi-factor-auth.mdx |
Removes imports and typo. |
docs/cloud/platform/create-account.mdx |
Removes import and fixes numbering. |
docs/cloud/manage-collections/enable-compression.mdx |
Adds HFresh guidance. |
docs/cloud/manage-clusters/default-settings.mdx |
Documents default vector index. |
docs/cloud/manage-clusters/connect.mdx |
Removes import and fixes copy. |
docs/cloud/manage-clusters/authorization.mdx |
Removes dead imports. |
docs/cloud/manage-clusters/authentication.mdx |
Removes dead imports. |
docs/cloud/embeddings/quickstart.mdx |
Adds client installation tabs. |
_includes/weaviate-embeddings-multimodal-models.mdx |
Corrects token limit. |
_includes/wcs/restart-warning.mdx |
Removes obsolete warning include. |
_includes/feature-notes/boost.mdx |
Applies house style. |
_includes/code/java-v6/src/test/java/SearchGenerativeTest.java |
Corrects snippet markers. |
_includes/code/java-v6/src/test/java/GetStartedTest.java |
Uses Ollama vectorization. |
_includes/code/java-v6/src/test/java/ConnectionTest.java |
Corrects snippet marker. |
_includes/code/howto/configure-sq/sq-compression.options-v3.ts |
Replaces copied BQ example with SQ. |
_includes/code/howto/configure-sq/sq-compression-v3.ts |
Corrects SQ configuration and assertions. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| <summary>Example full response in JSON format</summary> | ||
| <summary>Example response</summary> | ||
|
|
||
| ```json |
| <summary>Example full response in JSON format</summary> | ||
| <summary>Example response</summary> | ||
|
|
||
| ```json |
# Conflicts: # docs/cloud/embeddings/quickstart.mdx # docs/deploy/configuration/backups.md # docs/deploy/configuration/env-vars/index.md # docs/deploy/installation-guides/embedded.md # docs/weaviate/client-libraries/go.md # docs/weaviate/concepts/interface.md # docs/weaviate/model-providers/_includes/provider.vectorizer.py # docs/weaviate/model-providers/cohere/embeddings-multimodal.md # docs/weaviate/model-providers/google/embeddings-multimodal.md # docs/weaviate/model-providers/voyageai/embeddings.md # docs/weaviate/starter-guides/custom-vectors.mdx
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
Lands the low-severity tier of the 205-finding docs deep review. The high tier merged as #493 and the medium tier as #494-#497; this is the last of the three.
Seven reviewed PRs already merged into this branch: #498 model-providers structure, #499 model-providers copy-editing, #500 house style, #501 tutorials, #502 modules and connections, #503 assorted defects, #504 cloud.
What is in it. 43 of the 61 low findings. The rest were dropped as already fixed, refuted, or belonging to in-flight work rather than fixed twice.
Highlights, in rough order of reader impact:
Example full responseblock that was not valid JSON, on two pages. The sample code prints objects separately, so the fix matches what the code actually emits rather than wrapping them in an array they never form.gorawrather thango, because thegoformatter flattens a fullpackage mainprogram to column 0.Verified.
yarn build-devpasses. Broken links are unchanged from the baseline and broken anchors are down by one. A whole-repo simulation ofFilteredTextBlockacross all 3026 usages, A/B'd against the base, shows zero blank tabs introduced and two fixed.Not included, tracked separately. The larger findings this work surfaced but did not fix: the
REINDEX_MAP_TO_BLOCKMAX_*workflow is inert on v1.38.0+, the Go and Java clients sendalpha=0on hybrid queries where alpha is unset, and two C# RBAC client defects found by executing the new snippets against a live stack.