docs(tutorials): fix invalid JSON, a duplicate card icon, and em dashes - #501
Merged
Conversation
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.
![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 formatting, grammar, and icon issues across Weaviate tutorials.
Changes:
- Corrects wording and punctuation.
- Fixes tutorial-card icons.
- Revises malformed example output, though one JSON issue remains.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
tokenization.md |
Replaces em dashes. |
tls-ssl.mdx |
Improves punctuation. |
rbac.mdx |
Rephrases an em-dash clause. |
quick-tour-of-weaviate.mdx |
Revises malformed JSON output. |
index.mdx |
Fixes grammar and card icons. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| "question": "In 1953 Watson & Crick built a model of the molecular structure of this, the gene-carrying substance", | ||
| "category": "SCIENCE" | ||
| } | ||
| { |
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, 4 of 7. 5 findings, 5 files.
An "Example full response" block was wrapped as
{ {...}, {...} }, which is not valid JSON. The sample code prints each object separately, so an array would have shown 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 directly above it (the replacement was checked against the bundled Font Awesome stylesheet, since these render as CSS classes), another carried a literal tab in its icon string, two typos on the landing page, and six em dashes.
Verified: every JSON block on the page parsed; build exit 0.