docs: assorted one-line defects, plus a stale gRPC section and a silently wrong tab - #503
Open
g-despot wants to merge 1 commit into
Open
docs: assorted one-line defects, plus a stale gRPC section and a silently wrong tab#503g-despot wants to merge 1 commit into
g-despot wants to merge 1 commit into
Conversation
…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.
![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
Fixes assorted documentation defects, stale gRPC guidance, and missing language coverage.
Changes:
- Updates gRPC and client-language documentation.
- Repairs malformed links, tables, code fences, markers, and spelling.
- Removes empty headings and adds missing configuration details.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
docs/weaviate/starter-guides/custom-vectors.mdx |
Adds C# installation guidance. |
docs/weaviate/search/generative.md |
Fixes snippets, markers, and wording. |
docs/weaviate/search/boost.md |
Clarifies Python-only support. |
docs/weaviate/recipes.mdx |
Corrects grammar. |
docs/weaviate/configuration/rbac/manage-groups.mdx |
Removes a stray fence. |
docs/weaviate/concepts/interface.md |
Modernizes gRPC documentation. |
docs/weaviate/api/graphql/get.md |
Repairs operator reference links. |
docs/deploy/production/aws/network-security.md |
Removes empty headings and fixes wording. |
docs/deploy/installation-guides/embedded.md |
Documents gRPC configuration and corrects prose. |
docs/deploy/configuration/env-vars/index.md |
Fixes terminology and a link fragment. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| ### Python clients | ||
|
|
||
| [Python](docs/weaviate/client-libraries/python/index.mdx) v3 client support is new in `v3.15.4` for Linux and `v3.21.0` for macOS. The Python client v4 requires server version v1.23.7 or higher. | ||
| [Python](docs/weaviate/client-libraries/python/index.mdx) v3 client support is new in `v3.15.4` for Linux and `v3.21.0` for macOS. The Python client requires Weaviate `v1.23.7` or later. |
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, 6 of 7. 11 findings, 10 files.
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 introducing 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. Correction to an earlier version of this description: it claimed a reader who had selected C# was silently shown Python. That is how stock Docusaurus behaves, but this page uses
<Tabs className="code">, which this repo routes to its ownCodeDropdownTabs(src/theme/Tabs/index.js:466); that component keeps the reader's language and shows a visible "not yet available here" placeholder. So the C# tab was missing, not silently wrong. Adding it is still the right fix, and the prose above it promised examples the set did not have.Also: a malformed table row missing a cell, a stray fence with no opening, a Go placeholder fenced as TypeScript, a link fragment pointing nowhere, an undocumented
grpc_portparameter, two headings with no body, an orphaned include deleted, and a note that the boost page is Python-only (verified: zero matches in the TypeScript, Go, Java and C# clients).Verified: build exit 0; the previously blank Java tab now renders, confirmed in the built HTML.