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

docs: moving Icons to top level #405

Merged
merged 1 commit into from
Mar 12, 2024
Merged

Conversation

aversini
Copy link
Collaborator

@aversini aversini commented Mar 12, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the documentation structure to include an "Icons" section for easier access.
    • Changed the title for the icons component in the documentation to "Icons" for simplicity.

Copy link

coderabbitai bot commented Mar 12, 2024

Walkthrough

The update involves refining the documentation and presentation of icons within a project. Specifically, it adds a new section for icons in the documentation configuration and simplifies the title of the icons component story, changing it from a more complex hierarchical naming to a straightforward "Icons" title. This makes the icons section more accessible and easier to find in the documentation.

Changes

Files Change Summary
.../.ladle/config.mjs Added "Icons*" to the sections list.
.../src/Icons/Icons.stories.tsx Updated the title from "System/Icons" to "Icons".

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

Bundle Size (components)

Status File Size (Gzip) Limits
style.css 6.42 KB 8 KB
index.js 7.77 KB (+26 B +0.33%) 20 KB
vendor.js 65.07 KB 67 KB

Overall bundle size: 79.26 KB (+26 B +0.03%)
Overall status: ✅

Bundle Size (form components)

Status File Size (Gzip) Limits
index.js 4.66 KB (+1 B +0.02%) 20 KB
vendor.js 44.49 KB 67 KB

Overall bundle size: 49.15 KB (+1 B 0.00%)
Overall status: ✅

Bundle Size (system)

Status File Size (Gzip) Limits
style.css 6.7 KB 8 KB
index.js 1.74 KB (-1 B -0.06%) 3 KB
vendor.js 44.49 KB 46 KB

Overall bundle size: 52.93 KB (-1 B 0.00%)
Overall status: ✅

Copy link

@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.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 4f896a5 and fb44a66.
Files selected for processing (2)
  • packages/documentation/.ladle/config.mjs (1 hunks)
  • packages/documentation/src/Icons/Icons.stories.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • packages/documentation/src/Icons/Icons.stories.tsx
Additional comments: 1
packages/documentation/.ladle/config.mjs (1)
  • 14-14: The addition of "Icons*" to the storyOrder array is a positive change that aligns with the PR's objectives to enhance the visibility and accessibility of the Icons documentation. It's important to ensure that this change integrates well with the overall documentation structure and maintains consistency with other top-level sections.

@aversini aversini merged commit 757c3fa into main Mar 12, 2024
5 checks passed
@aversini aversini deleted the docs-moving-Icons-to-top-level branch March 12, 2024 15:31
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