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

feature(documentation-website): introduce million #944

Merged
merged 5 commits into from
May 1, 2024

Conversation

Idrinth
Copy link
Member

@Idrinth Idrinth commented May 1, 2024

The Pull Request is ready

Overview

  • adds million to improve react's performance

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

Copy link
Contributor

coderabbitai bot commented May 1, 2024

Walkthrough

The recent update to the documentation-website project involves incorporating new dependencies like million and chrome-launcher, updating existing ones such as @babel/plugin-syntax-import-attributes and vite, refining import statements for better typing, and adjusting plugin configurations in the Vite setup to enhance the functionality and maintainability of the codebase.

Changes

File Path Change Summary
documentation-website/package.json Added million, chrome-launcher; Updated @babel/plugin-syntax-import-attributes, vite
documentation-website/src/pages/contributing/index.tsx Updated import statement for pkg with type specification
documentation-website/vite.config.ts Adjusted plugin setup, added million and babel-plugin-istanbul
documentation-website/.knip.json Added "rollup" to ignoreDependencies list

Assessment against linked issues

Objective Addressed Explanation
Check if million.dev is useful (#645)

Poem

In the realm of code, where logic reigns,
New paths are forged, not one remains.
A dance of plugins, a symphony new,
million joins, as changes brew.
🌟 Through the wires, progress flows,
As CodeRabbit watches, the project grows.


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 May 1, 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: 2

documentation-website/vite.config.ts Outdated Show resolved Hide resolved
documentation-website/vite.config.ts Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot previously approved these changes May 1, 2024
@Idrinth Idrinth marked this pull request as ready for review May 1, 2024 19:07
Copy link

sonarqubecloud bot commented May 1, 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

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 @Idrinth - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 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/vite.config.ts Show resolved Hide resolved
documentation-website/vite.config.ts Show resolved Hide resolved
@Idrinth Idrinth merged commit 90f5eb1 into the-one May 1, 2024
59 of 62 checks passed
@Idrinth Idrinth deleted the issue-645-introduce-million branch May 1, 2024 19:24
@github-actions github-actions bot added this to the 2.8.0 milestone May 1, 2024
@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.

check if million.dev could be useful to us
1 participant