Small docs fix #877

GoldGroove06 · 2025-02-15T13:37:51Z

Fixes #872 and #873
makes the overflowing card scroll
https://github.com/user-attachments/assets/580aa818-1057-4723-ba4b-df35ca4bb641

Summary by CodeRabbit

Documentation
- Added new sections in the Button docs to showcase variants and sizes.
- Updated button examples to feature a unified label for clarity.
Style
- Enhanced responsiveness by replacing fixed pixel styles with adaptable classes in component examples.
- Refined layout settings across multiple examples to improve alignment and content flow on various screen sizes.
- Adjusted styling in the Separator documentation to improve table layout.
- Updated layout properties in the main layout component for better responsiveness.

coderabbitai · 2025-02-15T13:47:00Z

Walkthrough

This pull request updates several documentation components by replacing fixed inline styles with responsive Tailwind CSS classes and standardizing text labels. Changes include modifying the width styles for components like Accordion, Card, and Progress, updating button text from "Click Me!" to "Button" (with a span wrapper in one case), and adding new documentation sections for button variants and sizes. Minor adjustments to layout structure and class names further enhance the responsiveness and presentation of the documentation pages.

Changes

File(s)	Change Summary
`docs/app/docs/components/accordion/.../example_1.tsx`	Replaced the inline `width: "400px"` style with responsive Tailwind classes (`w-64 md:w-96`) for the Accordion wrapper.
`docs/app/docs/components/button/examples/{ButtonColor,ButtonSizes,ButtonVariants}.tsx`	Updated button text from "Click Me!" to "Button" with ButtonSizes now wrapping text in a `<span>` to allow additional styling.
`docs/app/docs/components/button/page.js`	Added two new `Documentation.ComponentHero` sections—"Variants" and "Sizes"—to the ButtonDocs component.
`docs/app/docs/components/kbd/page.js`	Replaced fixed inline styles for the Card component with Tailwind classes (`w-[80%] h-24`) to achieve a responsive layout.
`docs/app/docs/components/progress/{docs/codeUsage.js,page.js}`	Changed the progress component’s width from a fixed "200px" to a relative "90%" and updated Card styling for responsiveness.
`docs/app/docs/components/separator/page.js`	Removed the `max-w-screen-md` class from the wrapping `<div>` to adjust the layout of the documentation table.
`docs/app/docs/layout.tsx`	Modified class names of a `<div>` wrapping the Callout component for responsive design adjustments.
`docs/components/layout/Documentation/helpers/ComponentHero/ComponentHero.js`	Modified the container’s class names to include `justify-evenly overflow-x-auto` alongside flex properties.

Possibly related PRs

Docs scroll fix #830: Modified the Layout component in docs/app/docs/layout.tsx to improve responsiveness, paralleling this PR's layout changes.
Part 2: fixed linter issues #342: Adjusted styling for the Accordion component, similar to the updated approach in this PR.
Better Docs Structure #694: Introduced an AccordionExample component and documentation structure changes directly related to the Accordion modifications.

Suggested labels

automerge

Suggested reviewers

kotAPI

Poem

I'm a little rabbit, coding with delight,
Hoping through styles by day and night.
Fixed widths now flow with Tailwind might,
Buttons sing "Button" in text so light.
Docs refreshed, neat and bright,
Happy hops in every commit's flight!
Cheers from my bunny heart, pure and right!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/app/docs/layout.tsx

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

docs/components/layout/Documentation/helpers/ComponentHero/ComponentHero.js

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

📜 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 8cec2e5 and a75b89b.

📒 Files selected for processing (2)

docs/app/docs/layout.tsx (1 hunks)
docs/components/layout/Documentation/helpers/ComponentHero/ComponentHero.js (1 hunks)

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

docs/app/docs/layout.tsx
docs/components/layout/Documentation/helpers/ComponentHero/ComponentHero.js

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

GitHub Check: build
GitHub Check: Analyze (javascript)

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

kotAPI · 2025-02-15T15:31:37Z

docs/app/docs/layout.tsx

            </div>
            <div className='lg:px-4 text-gray-1000 flex-1 flex flex-col gap-4 overflow-y-scroll pt-2' id="docs-content">

-                <div className='mt-2 max-w-[1440px] mx-auto' >


this was making the page overflow on mobile devices

this also avoids stretching on wide/big screens

i will look into it and make changes accordingly

to simulate how this might look on a 4k screen for example - you can zoom out in your browser to 50% and see how the content looks in the layout

this will give you a good idea if it looks good or not, I've recently added this to fix the stretching issue, see how you can satisfy both situations

kotAPI · 2025-02-15T15:31:43Z

docs/app/docs/components/separator/page.js

                    </div>
                </div>
            </Documentation.ComponentHero>
-            <div className="max-w-screen-md">


the classname max-w-screen-md prevents the stretch of the tables it is removed now cuz the Documentation.Table already has the class

kotAPI · 2025-02-15T15:32:22Z

docs/app/docs/components/kbd/page.js

            Kbd is a component that can be used to display keyboard keys.
        `}>
            <Documentation.ComponentHero codeUsage={codeUsage}>
-                <Card className="flex items-center justify-center bg-gray-50" style={{width:"600px",height:"120px"}}>


hardcoding height will remove its responsiveness

its removed and the additions works

GoldGroove06 added 2 commits February 15, 2025 00:21

small fixes to kbd and progress

8650d00

Buttons fixed with scroll

8cec2e5

GoldGroove06 requested a review from kotAPI February 15, 2025 13:37

kotAPI reviewed Feb 15, 2025

View reviewed changes

small fixes to layout for larger screens

a75b89b

kotAPI approved these changes Feb 15, 2025

View reviewed changes

kotAPI enabled auto-merge (squash) February 15, 2025 17:21

kotAPI added the automerge A tag that tells kodiak bot to automerge PRs for us when tests and approval conditions are met label Feb 15, 2025

kotAPI merged commit 7aa7d55 into main Feb 15, 2025
7 checks passed

kotAPI deleted the small-docs-fix branch February 15, 2025 17:22

Uh oh!

Small docs fix #877

Small docs fix #877

Uh oh!

Conversation

GoldGroove06 commented Feb 15, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

GoldGroove06 commented Feb 15, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 15, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)