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

Issue 534 css split #925

Merged
merged 21 commits into from
Apr 29, 2024

Conversation

marikadeveloper
Copy link
Contributor

@marikadeveloper marikadeveloper commented Apr 29, 2024

The Pull Request is ready

Overview

I did a css refactor that involved the following things:

  • Moved all components styles in their own [component].scss file
  • Sorted all css properties in alphabetical order
  • Refactored index.scss file styles using the nesting capabilities of scss

Review points

  • There's a .dark-mode-icon class that I think is unused.
  • I had to add two comments to ignore style linting because fixing them requires using plain css syntax instead of scss nesting...

Documentation-Website

  • mobile view is usable
  • desktop view is usable
  • no a-tags are used directly (NavLink, MailLink, ExternalLink instead)
  • all new texts are added to the translation files (at least the english one)
  • tests have been added (if required)
  • shared code has been extracted in a different file

marikadeveloper and others added 18 commits April 24, 2024 17:50
…ench#534)

Create header.scss file to contain the styles extracted from index.scss
…ench#534)

Create header.scss file to contain the styles extracted from index.scss
Copy link
Contributor

coderabbitai bot commented Apr 29, 2024

Walkthrough

CodeRabbit has assimilated changes across multiple SCSS and TypeScript files in the documentation-website project to enhance modularity and maintainability of CSS. These changes align with the goal to split and organise CSS into module-specific files.

Changes

File Path Change Summary
.../breadcrumbs.scss, .../breadcrumbs.tsx Introduced and linked new styling for breadcrumbs.
.../code.scss, .../contributor.scss, .../cookie-consent.scss, .../external-link.scss, .../faq-item.scss Adjusted and reordered CSS properties.
.../dark-mode-button.scss, .../dark-mode-button.tsx, .../footer.scss, .../footer.tsx, .../header.scss, .../header.tsx, .../loader.scss, .../loader.tsx Added new styling files and linked them in corresponding TypeScript components.
.../youtube.scss, .../index.scss Modified styles to improve layout and responsiveness.

Assessment against linked issues

Objective Addressed Explanation
Split the index.css in /documentation-website (#534)

Poem

To the land of code, where styles cascade,
A new order emerges, no longer delayed.
🌐 With each file, so neatly arrayed,
Complexity reduced, the foundation laid.
🚀 Rejoice in the modular parade!

CodeRabbit acknowledges the completion of the objective.


Recent Review Details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 104b67e and d6d3682.
Files selected for processing (1)
  • documentation-website/src/components/footer.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • documentation-website/src/components/footer.tsx

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:

Note: Auto-reply has been disabled for this repository by the repository owner. 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.

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

@github-actions github-actions bot added the component: documentation-website related to the project's website, not the framework label Apr 29, 2024
Copy link
Contributor

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

Actionable comments posted: 8

border: 1px solid #fff;
}

img {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Selector specificity conflict detected.

The selector "header.header nav img" should be defined before "header.header #logo img" to maintain the expected cascading order of CSS rules. Consider reordering the selectors to avoid potential styling conflicts.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marikadeveloper feel free to move #logo into the header block where it belongs

}
}

ul {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Selector specificity conflict detected.

The selector "header.header .socials ul" should be defined before "header.header .socials li:hover ul" to maintain the expected cascading order of CSS rules. Consider reordering the selectors to avoid potential styling conflicts.

background: var(--background-color);
color: var(--text-color);
height: 100vh;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reintroduction of potentially problematic style.

The style height: 100vh; has been reintroduced to the html element. This might cause layout issues on mobile devices where the viewport height changes dynamically (e.g., when the address bar appears or disappears). Consider using min-height or other responsive techniques.

documentation-website/src/components/header.tsx Outdated Show resolved Hide resolved
@marikadeveloper marikadeveloper marked this pull request as ready for review April 29, 2024 09:30
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @marikadeveloper - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 7 issues found
  • 🟢 Security: all looks good
  • 🟡 Testing: 5 issues found
  • 🟢 Complexity: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

documentation-website/src/index.scss Show resolved Hide resolved
documentation-website/src/components/header.scss Outdated Show resolved Hide resolved
documentation-website/src/components/header.tsx Outdated Show resolved Hide resolved
documentation-website/src/components/footer.tsx Outdated Show resolved Hide resolved
Copy link
Member

@Idrinth Idrinth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty good!

documentation-website/src/components/footer.scss Outdated Show resolved Hide resolved
documentation-website/src/components/dark-mode-button.scss Outdated Show resolved Hide resolved
documentation-website/src/components/dark-mode-button.scss Outdated Show resolved Hide resolved
marikadeveloper and others added 2 commits April 29, 2024 18:39
Remove duplicate code inside dark-mode-button
Remove excess trailing spaces in dark-mode-button
Remove superfluous classes in header and footer
Fix selector specificity on header file
Copy link

sonarcloud bot commented Apr 29, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

@Idrinth Idrinth merged commit 9f4d23c into idrinth-api-bench:the-one Apr 29, 2024
47 of 50 checks passed
@github-actions github-actions bot added this to the 2.8.0 milestone Apr 29, 2024
@marikadeveloper marikadeveloper deleted the issue-534-css-split branch May 5, 2024 13:53
@Idrinth Idrinth modified the milestones: URGENT, Up for grabs May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation-website related to the project's website, not the framework
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Split the index.css in /documentation-website
2 participants