docs(modules,connections): fix Go tab rendering, a stale image tag, and unreachable pages - #502
Merged
Conversation
…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.
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Secrets | View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
Fixes documentation rendering, stale module image tags, and missing navigation paths.
Changes:
- Corrects Go syntax highlighting while preserving indentation.
- Updates Contextionary image tags.
- Restores module links and fixes a Java snippet marker.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
docs/weaviate/modules/sum-transformers.md |
Updates the Contextionary image tag. |
docs/weaviate/modules/spellcheck.md |
Updates the Contextionary image tag. |
docs/weaviate/modules/ner-transformers.md |
Updates the Contextionary image tag. |
docs/weaviate/modules/index.md |
Adds missing module links and fixes text and anchor navigation. |
docs/weaviate/connections/connect-cloud.mdx |
Corrects Go code rendering. |
_includes/code/java-v6/src/test/java/ConnectionTest.java |
Corrects the snippet end marker. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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, 5 of 7. 4 findings, 6 files.
Two Go tabs were tagged as Python, so Go rendered with Python highlighting. They are now
gorawrather thango. That is deliberate and differs from the sibling page: thegoformatter strips two tabs from two-tab lines and one from one-tab lines, collapsing a fullpackage mainprogram to column 0, so copying the sibling would have traded a highlighting bug for an indentation bug.gorawpreserves nesting and still highlights as Go.Three module pages pinned a contextionary image tag that appears in no live source (
en0.16.0-v1.0.2, found only in a 2023 blog post and stale build artifacts). The canonical tag, used by weaviate core's compose files and by docs CI, isen0.16.0-v1.2.1.Four module pages existed in the sidebar but were unreachable from the index body, and one bullet pointed at an anchor that was never defined.
Verified: build exit 0; all 13 marker regions in the touched Java fixture render byte-identically.