Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(ColorDocs): fixing docs page #1444

Merged
merged 1 commit into from
Nov 29, 2024
Merged

fix(ColorDocs): fixing docs page #1444

merged 1 commit into from
Nov 29, 2024

Conversation

VadymBezpalko
Copy link
Contributor

@VadymBezpalko VadymBezpalko commented Nov 28, 2024

Resolves: #1443

Description

Storybook

https://feature-1443--613a8e945a5665003a05113b.chromatic.com

Checklist

Obligatory:

  • Self review (use this as your final check for proposed changes before requesting the review)
  • Add correct label
  • Assign pull request with the correct issue

Summary by CodeRabbit

  • Bug Fixes
    • Corrected the reference for the "Secondary" surface color tokens to ensure accurate color display in the documentation.

Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes involve updating the Color.mdx file to correct the reference for the "Secondary" surface color in the ColorTable component. The previous reference to ColorGroup.SurfacePrimary has been changed to ColorGroup.SurfaceSecondary, ensuring accurate display of color tokens for the secondary surface category. No other sections or components in the document were altered.

Changes

Files Change Summary
packages/react-components/src/stories/foundations/Color/Color.mdx Updated ColorTable reference from ColorGroup.SurfacePrimary to ColorGroup.SurfaceSecondary in the "Secondary" section.

Assessment against linked issues

Objective Addressed Explanation
Fix naming in Storybook documentation (#1443)

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 6e42a71 and 8732025.

📒 Files selected for processing (1)
  • packages/react-components/src/stories/foundations/Color/Color.mdx (1 hunks)
🔇 Additional comments (1)
packages/react-components/src/stories/foundations/Color/Color.mdx (1)

96-96: LGTM! Documentation fix matches the section intent.

The change correctly updates the ColorTable to use ColorGroup.SurfaceSecondary for the Secondary surfaces section, fixing the previous inconsistency where it was showing Primary surface colors.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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 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.

@VadymBezpalko VadymBezpalko merged commit ef9bfcc into main Nov 29, 2024
8 checks passed
@VadymBezpalko VadymBezpalko deleted the feature/1443 branch November 29, 2024 09:41
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.

[Storybook documentation] - fix naming
2 participants