fix: readable max width docs style #343

rortan134 · 2024-08-11T14:26:36Z

Before

After

Summary by CodeRabbit

New Features
- Improved responsive design for document items, enhancing adaptability to various screen sizes.
- Introduced a centered layout for better visual presentation on wider screens.

vercel · 2024-08-11T14:26:40Z

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

Name	Status	Preview	Comments	Updated (UTC)
zenstack-new-site	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 11, 2024 2:27pm

coderabbitai · 2024-08-11T14:26:41Z

Walkthrough

The changes focus on enhancing the responsive design of the .docItemCol class in the styles.module.css file. A hardcoded max-width has been replaced with a flexible CSS variable, improving maintainability and adaptability across different screen sizes. Additionally, the introduction of margin: 0 auto; allows for better horizontal centering of the column, contributing to an overall improved layout.

Changes

Files	Change Summary
`src/theme/DocItem/Layout/...`	Updated `.docItemCol` class to use a flexible CSS variable for `max-width` and added centering styles.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant CSS

    User->>Browser: Resizes window
    Browser->>CSS: Applies media query for widths > 997px
    CSS->>Browser: Sets max-width to --readableMaxWidth
    CSS->>Browser: Centers .docItemCol with margin: 0 auto;
    Browser->>User: Displays updated layout

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2a09d3e and 7069d0c.

Files selected for processing (1)

src/theme/DocItem/Layout/styles.module.css (1 hunks)

Additional comments not posted (2)

src/theme/DocItem/Layout/styles.module.css (2)

9-9: LGTM!

Using a CSS variable for max-width enhances flexibility and maintainability. The !important flag ensures the style is applied as intended.

10-10: LGTM!

Adding margin: 0 auto; effectively centers the .docItemCol element horizontally, enhancing the layout's aesthetics.

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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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

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

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.

rortan134 · 2024-08-11T14:26:55Z

This is what Stripe uses btw

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-08-11T14:27:31Z

src/theme/DocItem/Layout/styles.module.css

 @media (min-width: 997px) {
  .docItemCol {
-    max-width: 75% !important;
+      --readableMaxWidth: calc(calc(1080px*0.25)*3);


Consider simplifying the calc() usage.

The nested calc() functions can be simplified for better readability. The current expression calc(calc(1080px*0.25)*3) can be directly written as calc(1080px * 0.75).

- --readableMaxWidth: calc(calc(1080px*0.25)*3); + --readableMaxWidth: calc(1080px * 0.75);

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

--readableMaxWidth: calc(calc(1080px*0.25)*3);

--readableMaxWidth: calc(1080px * 0.75);

ymc9 · 2024-08-17T17:16:54Z

Hi @rortan134 , thanks for the PR and sorry for the delay.

I feel it looks better on my MBP (upper one is with your change).

On a 4K display (browser scaled to 120%), it looks a bit too narrow to me:

How do you feel about it?

fix: readable max width style

7069d0c

vercel bot deployed to Preview August 11, 2024 14:27 View deployment

coderabbitai bot reviewed Aug 11, 2024

View reviewed changes

ymc9 merged commit c4e4741 into zenstackhq:main Aug 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: readable max width docs style #343

fix: readable max width docs style #343

Uh oh!

rortan134 commented Aug 11, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Aug 11, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented Aug 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

rortan134 commented Aug 11, 2024

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Aug 11, 2024

Uh oh!

ymc9 commented Aug 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	--readableMaxWidth: calc(calc(1080px0.25)3);
	--readableMaxWidth: calc(1080px * 0.75);

Uh oh!

fix: readable max width docs style #343

fix: readable max width docs style #343

Uh oh!

Conversation

rortan134 commented Aug 11, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Aug 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Aug 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

rortan134 commented Aug 11, 2024

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Aug 11, 2024

Choose a reason for hiding this comment

Uh oh!

ymc9 commented Aug 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

rortan134 commented Aug 11, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Aug 11, 2024 •

edited

Loading

coderabbitai bot commented Aug 11, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)