chore(docs): update documentation #1892
Conversation
|
|
LGTM 👍 |
bc424eb to
1eb32a4
Compare
|
@AVGVSTVS96 is attempting to deploy a commit to the assistant-ui Team on Vercel. A member of the Team first needs to authorize it. |
d8bf583 to
c164d2f
Compare
There was a problem hiding this comment.
PR Summary
Updated the SyntaxHighlighting documentation with improved clarity and technical accuracy around syntax highlighting configuration and options.
- Added warning callout clarifying syntax highlighting is not enabled by default in markdown
- Enhanced options table with direct links to type definitions in react-shiki source code
- Added explanation for type table order reversal due to fumadocs update on 4/22/25
- Improved formatting of code examples and callouts for better readability
- Updated default values and type descriptions for better technical accuracy
💡 (2/5) Greptile learns from your feedback when you react with 👍/👎!
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
📝 Documentation updates detected! You can review documentation updates here |
WalkthroughThe changes in this update focus exclusively on revising documentation content within the SyntaxHighlighting.mdx file. The edits include rephrasing the warning about syntax highlighting, reformatting descriptions of syntax highlighting options from bulleted lists to a more compact style, and adjusting whitespace in installation instructions. The 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (1)
apps/docs/content/docs/ui/SyntaxHighlighting.mdx(4 hunks)
🧰 Additional context used
🪛 LanguageTool
apps/docs/content/docs/ui/SyntaxHighlighting.mdx
[grammar] ~11-~11: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...">Syntax highlighting is not enabled in markdown by default. <Callout type="i...
(MARKDOWN_NNP)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: mrge · AI code reviewer
🔇 Additional comments (6)
apps/docs/content/docs/ui/SyntaxHighlighting.mdx (6)
57-66: Verify updated default theme and type link.The default theme was changed to
github-dark, and the link points to a specific commit. Please confirm:
github-darkis the intended default in the latestreact-shikirelease.- The
typeDescriptionLinkstays valid over time (consider linking to a tag or branch instead of a SHA).
67-74: Review thelanguagedefault and type URL.The
languageprop now defaults to"text". Ensure this aligns with theLanguagetype inreact-shikiand that the link correctly references the source:- language: { - type: "Language", - default: "text", + language: { + type: "Language", + default: "text",
75-84: ApproveclassNameandstyleprops.The entries for
className(default"") andstyle(defaultundefined) follow common React conventions and improve clarity.
85-98: ApprovecssVariablePrefixanddefaultColorupdates.The
cssVariablePrefixdefault and the change ofdefaultColordefault toundefined(from earlier{}) both enhance flexibility. The type links appear correct.
112-118: Approvetransformersentry.The
transformersprop has an accurate description, type link, and default value.
126-126: Approve upcoming feature callout.The info callout about full Shiki option support coming soon is clear and helpful.
| <Callout type="warn"> | ||
| Syntax highlighting is not included by default. | ||
| </Callout> | ||
| <Callout type="warn">Syntax highlighting is not enabled in markdown by default.</Callout> |
There was a problem hiding this comment.
🧹 Nitpick (assertive)
Capitalize 'Markdown' in warning callout.
To follow proper noun usage, change "markdown" to "Markdown" in the warning:
-<Callout type="warn">Syntax highlighting is not enabled in markdown by default.</Callout>
+<Callout type="warn">Syntax highlighting is not enabled in Markdown by default.</Callout>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Callout type="warn">Syntax highlighting is not enabled in markdown by default.</Callout> | |
| <Callout type="warn">Syntax highlighting is not enabled in Markdown by default.</Callout> |
🧰 Tools
🪛 LanguageTool
[grammar] ~11-~11: Did you mean the formatting language “Markdown” (= proper noun)?
Context: ...">Syntax highlighting is not enabled in markdown by default. <Callout type="i...
(MARKDOWN_NNP)
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
apps/docs/content/docs/ui/SyntaxHighlighting.mdx (3)
11-11: Capitalize 'Markdown' in warning callout
To follow proper noun usage, change "markdown" to "Markdown".-<Callout type="warn">Syntax highlighting is not enabled in markdown by default.</Callout> +<Callout type="warn">Syntax highlighting is not enabled in Markdown by default.</Callout>
105-111: RefinecustomLanguagesdefault display
The default value is shown as a string; use an actual empty array literal for clarity.- customLanguages: { - description: "Custom languages to preload for highlighting", - type: "Language[]", - typeDescriptionLink: ".../types.ts#L24", - default: "[]", - }, + customLanguages: { + description: "Custom languages to preload for highlighting", + type: "Language[]", + typeDescriptionLink: ".../types.ts#L24", + default: [], + },
14-16: 🧹 Nitpick (assertive)Replace ampersand with 'and' for consistency
Use "and" instead of "&" to match the wording style in other callouts.- - **react-shiki** (recommended for performance & dynamic language support) + - **react-shiki** (recommended for performance and dynamic language support)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Lite
📒 Files selected for processing (1)
apps/docs/content/docs/ui/SyntaxHighlighting.mdx(4 hunks)
🔇 Additional comments (11)
apps/docs/content/docs/ui/SyntaxHighlighting.mdx (11)
32-34: The file path is already wrapped in backticks, so no further change is needed here.
57-66: Approve theme entry enhancements
Thethemeproperty now accurately links to its type definition, defaults togithub-dark, and marks the field as required.
67-74: Approve language entry improvements
Thelanguageproperty is clearly specified, linked, and marked as required—good documentation update.
75-79: Approve className entry
Clear description and sensible default for the<pre>element’s CSS classes.
80-84: Approve style entry
Usingundefinedas the default for inline styles is appropriate and clearly documented.
85-90: Approve cssVariablePrefix entry
Prefix logic is well-described and the default value is sensible.
91-98: Approve defaultColor entry
Detailed description, correct type link, andundefineddefault align with intended behavior.
99-104: Approve delay entry
Millisecond delay documentation is clear and defaulting to0makes sense.
119-121: The inline comment placement above.reverse()has already been addressed.
126-126: No action needed for this informational callout.
178-181: Documentation warning for deprecation is clear
The callout clearly advises usingreact-shikiover the legacy option.
f3506a4 to
1312c39
Compare
|
@trag-bot didn't find any issues in the code! ✅✨ |
Pull request summary
|
There was a problem hiding this comment.
PR Summary
Based on the most recent changes to the SyntaxHighlighting documentation, here's a concise summary of the key updates:
Documentation updates to improve clarity and technical accuracy in the SyntaxHighlighting component configuration.
- Fixed capitalization of "Markdown" in warning callout for proper noun usage
- Changed ampersand to "and" in react-shiki description for consistent documentation style
- Updated customLanguages default value display to use proper array literal format
- Improved type descriptions and links for better source code reference
Note: This summary focuses only on the most recent changes not covered in previous reviews, avoiding repetition of points already mentioned.
1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile
|
📝 Documentation updates detected! You can review documentation updates here |
Some minor documentation updates
Important
Updated
SyntaxHighlighting.mdxdocumentation forreact-shikiandreact-syntax-highlighteroptions, including rephrased callouts and updated default values.SyntaxHighlighting.mdx.assistant-uiprovides two options for syntax highlighting.react-shikitogithub-darkand added links to type descriptions inSyntaxHighlighting.mdx.react-syntax-highlighterin future releases.This description was created by
for 1312c39. You can customize this summary. It will automatically update as commits are pushed.