docs: house-style sweep across reference and concepts pages - #500
Open
g-despot wants to merge 2 commits into
Open
docs: house-style sweep across reference and concepts pages#500g-despot wants to merge 2 commits into
g-despot wants to merge 2 commits into
Conversation
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.
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Secrets |  0  0  0  0 |
View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation house style while correcting stale references and links.
Changes:
- Replaces em dashes with context-appropriate punctuation.
- Removes client-library version numbers from prose.
- Corrects the
gsetokenizer casing, an environment-variable anchor, and a TypeScript import.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/weaviate/manage-objects/read-all-objects.mdx |
Removes a client version reference. |
docs/weaviate/manage-objects/import.mdx |
Revises punctuation. |
docs/weaviate/manage-objects/create.mdx |
Corrects the TypeScript import extension. |
docs/weaviate/connections/connect-query.mdx |
Revises punctuation and sentence structure. |
docs/weaviate/connections/connect-custom.mdx |
Removes client versions and revises list punctuation. |
docs/weaviate/config-refs/indexing/vector-index.mdx |
Revises punctuation in indexing guidance. |
docs/weaviate/config-refs/indexing/inverted-index.mdx |
Revises punctuation throughout the reference. |
docs/weaviate/config-refs/datatypes.md |
Revises punctuation in datatype guidance. |
docs/weaviate/concepts/storage.md |
Corrects an environment-variable anchor. |
docs/weaviate/concepts/search/vector-search.md |
Revises MMR descriptions. |
docs/weaviate/concepts/search/keyword-search.md |
Corrects gse casing and punctuation. |
docs/weaviate/concepts/indexing/inverted-index.md |
Revises stopword guidance punctuation. |
docs/weaviate/client-libraries/index.mdx |
Removes client version numbers. |
docs/weaviate/api/index.mdx |
Removes client version examples. |
docs/deploy/configuration/replication.md |
Revises replication guidance punctuation. |
docs/deploy/configuration/backups.md |
Revises backup guidance punctuation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| :::note Indexing and filtering | ||
|
|
||
| `object` and `object[]` properties are not vectorized — only their leaf scalars are stored in the inverted index. From Weaviate `v1.38` (preview), you can filter on nested-object leaves using a dotted path syntax. See [Filter on nested object properties](../search/filters.md#filter-on-nested-object-properties). | ||
| `object` and `object[]` properties are not vectorized: only their leaf scalars are stored in the inverted index. From Weaviate `v1.38` (preview), you can filter on nested-object leaves using a dotted path syntax. See [Filter on nested object properties](../search/filters.md#filter-on-nested-object-properties). |
…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
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.
Low tier, 3 of 7. 9 findings, 16 files.
33 em dashes replaced, each with the punctuation the sentence actually wants rather than a mechanical hyphen. Eight of these were never filed by the review, which is why a CI lint is tracked separately.
Client library version numbers removed from prose in five places. Where a version carried meaning the sentence was rewritten to say the same thing without a number that rots.
Two correctness items: the keyword-search page wrote the tokenizer as
GSE, but the config value is lowercasegseand the uppercase form is a schema validation error; and an env-var anchor was miscased, which fixes one of only two broken anchors in the whole build.Verified: build exit 0; broken anchors 2 to 1.