docs: fixywixy #1140

juliusmarminge · 2025-01-30T23:49:32Z

Summary by CodeRabbit

Dependency Updates
- Upgraded multiple packages to their latest versions, including Algolia Autocomplete, Scalar API Reference, Shiki, and others.
UI Changes
- Removed preview banner from the layout.
- Updated hero pattern to allow interactions with underlying elements.
Component Modifications
- Adjusted mutation observer logic for API reference rendering.
- Added group class to article card components for enhanced styling.

vercel · 2025-01-30T23:49:36Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 31, 2025 0:09am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
legacy-docs-uploadthing	⬜️ Ignored (Inspect)	Visit Preview		Jan 31, 2025 0:09am

changeset-bot · 2025-01-30T23:49:36Z

⚠️ No Changeset found

Latest commit: 7452cc8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2025-01-30T23:49:40Z

Walkthrough

This pull request involves several updates across different files in the documentation project. The changes primarily focus on dependency version upgrades in the package.json, modifications to the API reference component's loading state logic, removal of a preview banner from the client layout, and a minor styling adjustment in the hero pattern component. These updates reflect a maintenance effort to keep dependencies current and refine the user interface.

Changes

File	Change Summary
`docs/package.json`	Updated dependency versions: - `@algolia/autocomplete-core`: `^1.17.8` → `^1.18.0` - `@scalar/api-reference-react`: `^0.4.8` → `^0.4.21` - `@shikijs/transformers`: `^1.26.1` → `^1.29.2` - `fast-glob`: `^3.3.2` → `^3.3.3` - `motion`: `^12.0.0-alpha.2` → `^12.0.6` - `shiki`: `^1.26.1` → `^1.29.2`
`docs/src/app/(docs)/api-reference/openapi-spec/scalar-client.tsx`	Modified `useMutationObserver` function: - Removed class name checks for `"scalar-app"` and `"references-layout"` - Added new class name check for `"references-rendered"`
`docs/src/app/(docs)/client-layout.tsx`	Removed preview banner functionality: - Deleted `bannerOpen` state - Removed `useEffect` for setting banner state - Commented out `<PreviewBanner>` component
`docs/src/components/HeroPattern.tsx`	Updated `<div>` class attribute: - Added `pointer-events-none` to existing classes
`docs/src/app/blog/_components/article-card.tsx`	Added `group` class to `Card` component in `ArticleCard` and `FeaturedArticle` functions.

Possibly related PRs

fix(docs): force path resolution #953: The changes in the main PR involve updates to package dependencies, which may indirectly relate to the functionality of the Tailwind CSS configuration modified in this PR, as both involve maintaining and enhancing the project's dependencies.
docs: you can generate signed urls yourself now #1133: While the main PR focuses on updating package versions, the changes in this PR regarding generating signed URLs may require certain dependencies to function correctly, suggesting a potential indirect relationship through shared dependencies or functionality.

Suggested reviewers

markflorkowski

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bc12f15 and 7452cc8.

📒 Files selected for processing (1)

docs/src/app/blog/_components/article-card.tsx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs/src/app/blog/_components/article-card.tsx

⏰ Context from checks skipped due to timeout of 90000ms (2)

GitHub Check: e2e-node (backend-adapters)
GitHub Check: build

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

markflorkowski · 2025-01-30T23:51:01Z

docs/src/app/(docs)/api-reference/openapi-spec/scalar-client.tsx

@@ -51,13 +51,13 @@ export default function ScalarApiRef() {

  const ref = useRef<HTMLDivElement>(null);
  useMutationObserver(ref, (args) => {
+    console.log("args", args);


Suggested change

console.log("args", args);

juliusmarminge · 2025-01-30T23:53:14Z

docs/src/app/(docs)/api-reference/openapi-spec/scalar-client.tsx

@@ -56,8 +56,7 @@ export default function ScalarApiRef() {
        (a) =>
          a.type === "attributes" &&
          a.target instanceof Element &&
-          a.target.classList.contains("scalar-app") &&
-          a.target.classList.contains("references-layout"),
+          a.target.classList.contains("references-rendered"),


cc @marclave can we have some onLoaded prop or <Suspense> support so we don't have to do this hacky mutation observer thing to unmount the loading state that's fragile to break when updating the package?

here you go

scalar/scalar#4750

github-actions · 2025-01-30T23:55:19Z

📦 Bundle size comparison

Bundle	Size (gzip)	Visualization
Main	30.67KB	See Treemap 📊
PR (`d0e48f2`)	30.67KB	See Treemap 📊
Diff	No change

fixywixy

4a8b585

github-actions bot added the 📚 documentation label Jan 30, 2025

dedupe

9223a62

markflorkowski approved these changes Jan 30, 2025

View reviewed changes

cool

dbe29d4

juliusmarminge commented Jan 30, 2025

View reviewed changes

vercel bot deployed to Preview – docs-uploadthing January 30, 2025 23:58 View deployment

fix card

bc12f15

vercel bot deployed to Preview – docs-uploadthing January 31, 2025 00:05 View deployment

cool

7452cc8

vercel bot deployed to Preview – docs-uploadthing January 31, 2025 00:09 View deployment

juliusmarminge merged commit 1ed7586 into main Jan 31, 2025
18 checks passed

coderabbitai bot mentioned this pull request Feb 11, 2025

docs: css fixes #1147

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: fixywixy #1140

docs: fixywixy #1140

juliusmarminge commented Jan 30, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jan 30, 2025 •

edited

Loading

changeset-bot bot commented Jan 30, 2025 •

edited

Loading

coderabbitai bot commented Jan 30, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

markflorkowski Jan 30, 2025

juliusmarminge Jan 30, 2025 •

edited

Loading

amritk Feb 11, 2025

amritk Feb 11, 2025

github-actions bot commented Jan 30, 2025 •

edited

Loading

docs: fixywixy #1140

docs: fixywixy #1140

Conversation

juliusmarminge commented Jan 30, 2025 • edited by coderabbitai bot Loading

Summary by CodeRabbit

vercel bot commented Jan 30, 2025 • edited Loading

changeset-bot bot commented Jan 30, 2025 • edited Loading

⚠️ No Changeset found

coderabbitai bot commented Jan 30, 2025 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

markflorkowski Jan 30, 2025

Choose a reason for hiding this comment

juliusmarminge Jan 30, 2025 • edited Loading

Choose a reason for hiding this comment

amritk Feb 11, 2025

Choose a reason for hiding this comment

amritk Feb 11, 2025

Choose a reason for hiding this comment

github-actions bot commented Jan 30, 2025 • edited Loading

📦 Bundle size comparison

juliusmarminge commented Jan 30, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jan 30, 2025 •

edited

Loading

changeset-bot bot commented Jan 30, 2025 •

edited

Loading

coderabbitai bot commented Jan 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

juliusmarminge Jan 30, 2025 •

edited

Loading

github-actions bot commented Jan 30, 2025 •

edited

Loading