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

add new intro video to homepage #1539

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

aherman3
Copy link
Contributor

@aherman3 aherman3 commented Jun 24, 2024

This PR adds the new and improved Wechaty intro video onto the homepage! The video is embedded as a local mp4.


🚀 This description was created by Ellipsis for commit dadee9d

Summary:

Added a new intro video to the homepage by embedding a local mp4 file and updating the relevant styles.

Key points:

  • Added new intro video to homepage in docusaurus/src/pages/features-section/features-section.tsx.
  • Embedded video as local mp4 file docusaurus/static/img/introduction-video.mp4.
  • Updated docusaurus/src/pages/features-section/features-section.css to style the video and its placeholder.
  • Video added within div with id videoPlaceholder and styled with id video.

Generated with ❤️ by ellipsis.dev

Summary by CodeRabbit

  • New Features

    • Added a video element to the Features section for improved user interaction.
  • Style

    • Adjusted the dimensions of video elements for better display across devices.
  • Chores

    • Updated the version of "wechaty-docusaurus" from 0.11.7 to 0.11.8.
    • Added mp4 to the list of allowed file types for static files.

Copy link
Contributor

coderabbitai bot commented Jun 24, 2024

Walkthrough

This update in Docusaurus incorporates several enhancements: resizing the video elements within the features section, integrating a new <video> element for improved user interaction, allowing .mp4 files in static content, and updating the project version in package.json. These changes collectively aim to improve the user experience and maintain the project's versioning.

Changes

Files/Paths Change Summary
docusaurus/src/pages/features-section/... Adjusted the dimensions of #video and #videoPlaceholder elements in features-section.css.
docusaurus/src/pages/features-section/... Added a <video> element within the FeaturesSection component in features-section.tsx.
.file-name-linter.json Added .mp4 to the list of allowed file extensions.
package.json Updated the project version from "0.11.7" to "0.11.8".

Poem

With code so fine, we tweak the line,
Videos resized, now looking prime.
A version bump, a cleaner flow,
New features shine, user delight grows.
Cheers to progress, in every byte,
CodeRabbit's hop, brings joy in sight! 🐇✨


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

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to dadee9d in 53 seconds

More details
  • Looked at 65 lines of code in 3 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docusaurus/src/pages/features-section/features-section.tsx:90
  • Draft comment:
    The video tag is missing the type attribute. It's important to include this to ensure proper video handling across different browsers.
  • Reason this comment was not posted:
    Confidence of 0% on close inspection, compared to threshold of 50%.

Workflow ID: wflow_xVMYFhMokQxJzOzN


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

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: 1

Outside diff range and nitpick comments (2)
docusaurus/src/pages/features-section/features-section.tsx (2)

Line range hint 100-100: Add href attribute to anchor tags for proper navigation.

The anchor tag in line 100 lacks an href attribute, which is essential for ensuring that the link is navigable and accessible.

-              <a target="_blank"> Wechaty </a>
+              <a href="https://example.com" target="_blank"> Wechaty </a>
Tools
Biome

[error] 90-94: Provide a track for captions when using audio or video elements. (lint/a11y/useMediaCaption)

Captions support users with hearing-impairments. They should be a transcription or translation of the dialogue, sound effects, musical cues, and other relevant audio information.


Line range hint 103-103: Ensure all anchor tags have href attributes.

The anchor tag in line 103 is missing an href attribute. This is a critical issue as it affects the usability and accessibility of the links.

-              <a target="_blank"> 6 lines of code.</a>
+              <a href="https://example.com" target="_blank"> 6 lines of code.</a>
Tools
Biome

[error] 90-94: Provide a track for captions when using audio or video elements. (lint/a11y/useMediaCaption)

Captions support users with hearing-impairments. They should be a transcription or translation of the dialogue, sound effects, musical cues, and other relevant audio information.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c97fbc0 and dadee9d.

Files ignored due to path filters (1)
  • docusaurus/static/img/introduction-video.mp4 is excluded by !**/*.mp4
Files selected for processing (2)
  • docusaurus/src/pages/features-section/features-section.css (3 hunks)
  • docusaurus/src/pages/features-section/features-section.tsx (1 hunks)
Files skipped from review due to trivial changes (1)
  • docusaurus/src/pages/features-section/features-section.css
Additional context used
Biome
docusaurus/src/pages/features-section/features-section.tsx

[error] 90-94: Provide a track for captions when using audio or video elements. (lint/a11y/useMediaCaption)

Captions support users with hearing-impairments. They should be a transcription or translation of the dialogue, sound effects, musical cues, and other relevant audio information.


[error] 100-100: Provide a href attribute for the a element. (lint/a11y/useValidAnchor)

An anchor element should always have a href
Check this thorough explanation to better understand the context.


[error] 103-103: Provide a href attribute for the a element. (lint/a11y/useValidAnchor)

An anchor element should always have a href
Check this thorough explanation to better understand the context.

@aherman3 aherman3 requested a review from huan June 24, 2024 12:13
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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between dadee9d and a1d8acd.

Files selected for processing (2)
  • .file-name-linter.json (1 hunks)
  • package.json (1 hunks)
Files skipped from review due to trivial changes (1)
  • package.json
Additional comments not posted (1)
.file-name-linter.json (1)

9-9: Approved: Addition of mp4 file type to linter rules.

The addition of the mp4 extension to the linter configuration is necessary to support the new video content on the homepage as described in the PR. This change ensures that the linter will not flag the new video file as an error, which is crucial for seamless integration.

@aherman3
Copy link
Contributor Author

aherman3 commented Jul 16, 2024

@huan To allow embedding the mp4 intro video, I added mp4 to the list of permitted file types. I'm thinking that embedding the local video file is best to avoid incompatibility with youtube or other external links, but let me know if you think an if uploading the video to youtube and adding a link is better

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