Skip to content

chore(docs): small updates#7494

Open
mhartington wants to merge 1 commit intomainfrom
chore/small-updates
Open

chore(docs): small updates#7494
mhartington wants to merge 1 commit intomainfrom
chore/small-updates

Conversation

@mhartington
Copy link
Member

@mhartington mhartington commented Feb 14, 2026

Summary by CodeRabbit

  • New Features

    • Added support for embedding tweets in blog posts.
  • Chores

    • Updated tracking configuration for documentation analytics.
    • Improved code style consistency across layout components.

@vercel
Copy link

vercel bot commented Feb 14, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Feb 14, 2026 6:27pm

Request Review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 14, 2026

Walkthrough

Multiple fumadocs library dependencies are bumped to versions 16.6.1 and 10.3.5 across package files. Type definitions in the docs layout component are refactored to use single-quoted string literals consistently. Marketing URLs are updated with new utm parameters.

Changes

Cohort / File(s) Summary
Dependency Version Updates
apps/blog/package.json, apps/docs/package.json, apps/eclipse/package.json, packages/eclipse/package.json
Bumps @fumadocs/base-ui, fumadocs-core, and fumadocs-ui to version 16.6.1; fumadocs-openapi to ^10.3.5. Adds react-tweet (^3.3.0) to blog dependencies. These updates affect transitive dependency resolution across multiple workspace applications.
Type Signature Styling
apps/docs/src/components/layout/notebook/index.tsx
Refactors exported type signatures to use single-quoted string literals instead of double quotes. Affects DocsLayoutProps.nav, SidebarOptions component type references, and banner/footer property types. Changes string literal styling in Pick utility type selections for consistency.
Configuration Link Updates
apps/docs/src/lib/layout.shared.tsx
Updates Discord link utm_medium parameter from "header" to "navbar". Replaces direct GitHub link with short URL redirect (pris.ly) containing utm tracking parameters. No functional changes to component behavior.

Estimated Code Review Effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 3
❌ Failed checks (2 warnings, 1 inconclusive)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Merge Conflict Detection ⚠️ Warning ❌ Merge conflicts detected (8 files):

⚔️ apps/blog/package.json (content)
⚔️ apps/docs/package.json (content)
⚔️ apps/docs/src/app/layout.tsx (content)
⚔️ apps/docs/src/components/layout/notebook/index.tsx (content)
⚔️ apps/docs/src/lib/layout.shared.tsx (content)
⚔️ apps/eclipse/package.json (content)
⚔️ packages/eclipse/package.json (content)
⚔️ pnpm-lock.yaml (content)

These conflicts must be resolved before merging into main.
Resolve conflicts locally and push changes to this branch.
Title check ❓ Inconclusive The title 'chore(docs): small updates' is vague and generic, using non-descriptive language that doesn't convey what was actually changed. Consider a more specific title that reflects the main changes, such as 'chore(deps): bump fumadocs packages to 16.6.1' or 'chore: update fumadocs dependencies and refactor type literals'.
✅ Passed checks (1 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Contributor

🍈 Lychee Link Check Report

3660 links: ✅ 2992 OK | 🚫 2 errors | 🔀 0 redirects | 👻 664 excluded

❌ Errors

./apps/docs/content/docs.v6/orm/more/dev-environment/editor-setup.mdx

  • [503] https://fig.io/ | Rejected status code (this depends on your "accept" configuration): Service Unavailable

./apps/docs/content/docs/orm/more/dev-environment/editor-setup.mdx

  • [503] https://fig.io/ | Rejected status code (this depends on your "accept" configuration): Service Unavailable

Full Statistics Table
Status Count
✅ Successful 2992
🔀 Redirected 0
👻 Excluded 664
🚫 Errors 2
⛔ Unsupported 2
⏳ Timeouts 0
❓ Unknown 0

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
apps/docs/src/lib/layout.shared.tsx (1)

59-59: ⚠️ Potential issue | 🟡 Minor

Pre-existing typo: "Managment" → "Management".

While not part of this diff, since this is a docs chore PR and you're already in the file, might be a nice quick win to fix.

-      { text: 'Managment API', url: '/management-api', active: 'nested-url' },
+      { text: 'Management API', url: '/management-api', active: 'nested-url' },
🤖 Fix all issues with AI agents
In `@apps/docs/src/components/layout/notebook/index.tsx`:
- Line 344: The navbar currently renders <ThemeToggle mode={themeSwitch.mode ??
'light-dark-system'} /> unconditionally; change it to honor the same guard used
in the sidebar (check themeSwitch.enabled !== false) so the toggle is only
rendered when enabled, or explicitly document/intentionally always show it if
that behavior is desired — update the conditional around the ThemeToggle in the
notebook component to reference themeSwitch.enabled (or themeSwitch?.enabled)
and keep the existing mode fallback.
🧹 Nitpick comments (1)
apps/docs/src/components/layout/notebook/index.tsx (1)

320-324: Commented-out i18n toggle — intentional?

This block is commented out rather than removed. If it's a temporary measure while the i18n feature is being reworked, a brief // TODO: comment explaining the intent would help future readers understand why it's here rather than deleted.

))}
</div>

<ThemeToggle mode={themeSwitch.mode ?? 'light-dark-system'} />
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

ThemeToggle is now rendered unconditionally.

Previously in the sidebar drawer (line 231-233), the theme toggle is guarded by themeSwitch.enabled !== false. Here in the navbar, the ThemeToggle renders regardless of the themeSwitch.enabled prop. If a consumer passes themeSwitch: { enabled: false }, they'd still see a toggle in the navbar — which may not be the intended behavior.

If this is deliberate (e.g., "always show toggle in navbar"), that's fine. Otherwise:

-            <ThemeToggle mode={themeSwitch.mode ?? 'light-dark-system'} />
+            {themeSwitch.enabled !== false && (
+              <ThemeToggle mode={themeSwitch.mode ?? 'light-dark-system'} />
+            )}
📝 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.

Suggested change
<ThemeToggle mode={themeSwitch.mode ?? 'light-dark-system'} />
{themeSwitch.enabled !== false && (
<ThemeToggle mode={themeSwitch.mode ?? 'light-dark-system'} />
)}
🤖 Prompt for AI Agents
In `@apps/docs/src/components/layout/notebook/index.tsx` at line 344, The navbar
currently renders <ThemeToggle mode={themeSwitch.mode ?? 'light-dark-system'} />
unconditionally; change it to honor the same guard used in the sidebar (check
themeSwitch.enabled !== false) so the toggle is only rendered when enabled, or
explicitly document/intentionally always show it if that behavior is desired —
update the conditional around the ThemeToggle in the notebook component to
reference themeSwitch.enabled (or themeSwitch?.enabled) and keep the existing
mode fallback.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant