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

Aherman3 getting started videos #1537

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

Conversation

aherman3
Copy link
Contributor

@aherman3 aherman3 commented Apr 17, 2024

This PR adds a link to the Wechaty getting-started video tutorials playlist on the Tutorials - Getting Started page. As well as fixes some small spelling mistakes.

Summary by CodeRabbit

  • Documentation

    • Updated the introductory section for beginners with a video series link and expanded descriptions of Wechaty's capabilities.
    • Corrected typos in tutorial URLs and enhanced clarity of instructions for beginners.
  • Chores

    • Incremented version from "0.11.7" to "0.11.10" in the package.json file.
    • Added a new dependency on "ts-node": "^10.9.2".

@aherman3 aherman3 requested a review from a team as a code owner April 17, 2024 06:36
Copy link
Contributor

coderabbitai bot commented Apr 17, 2024

Warning

Rate Limit Exceeded

@aherman3 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 34 minutes and 51 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 4536d2a and 5f23a15.

Walkthrough

The recent updates aim to enhance the Wechaty documentation and project configuration. Changes include refining content for beginners, updating file links for clarity, and introducing a new dependency for improved development capabilities.

Changes

File Path Change Summary
.../getting-started/overview.mdx Updated introductory section, added video series link, expanded fundamental features coverage.
.../tutorials/overview.md Corrected URL typos, improved instructions for Wechaty and chatbot development.
package.json Incremented version to "0.11.10", added dependency on "ts-node": "^10.9.2".

🐰✨
In the realm of code where changes brew,
A rabbit dances, updating with a view.
Links now shine with a clearer light,
Wechaty evolves, oh what a delight!
Cheers to the team, each version a story,
🎉📖 Progress unfolds, in all its glory!


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.

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.

Copy link
Member

@huan huan left a comment

Choose a reason for hiding this comment

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

Thank you, @aherman3 for creating this great getting started tutorial video play list, and add it to our website!

They look great!

However, I saw there are a lot of renaming from .mdx to .md, can you keep them unmodified, or explain why it is necessary to do the renaming?

package.json Outdated Show resolved Hide resolved
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: 3

Out of diff range and nitpick comments (5)
docusaurus/docs/getting-started/overview.mdx (2)

24-24: Add alt text to the video link for accessibility.

Consider adding descriptive alt text to the video link to improve accessibility. For example, "Watch Wechaty Getting Started Video Tutorials on YouTube".


Line range hint 57-57: Correct the typo "Gott" to "Go".

- Gott
+ Go
docusaurus/docs/tutorials/overview.md (3)

Line range hint 13-13: Add a comma after "tutorials" for better readability.

- In these tutorials you'll be building
+ In these tutorials, you'll be building

Line range hint 13-13: Correct the typo in "recieves" to "receives".

- recieves
+ receives

20-20: Consider adding a comma after "beginner" for better readability.

Adding a comma after "beginner" can improve the readability of the sentence.

docusaurus/docs/getting-started/overview.mdx Outdated Show resolved Hide resolved
docusaurus/docs/getting-started/overview.mdx Show resolved Hide resolved
docusaurus/docs/tutorials/overview.md Outdated Show resolved Hide resolved
aherman3 and others added 2 commits April 23, 2024 11:24
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@aherman3
Copy link
Contributor Author

Thank you, @aherman3 for creating this great getting started tutorial video play list, and add it to our website!

They look great!

However, I saw there are a lot of renaming from .mdx to .md, can you keep them unmodified, or explain why it is necessary to do the renaming?

Actually, this change wasn't needed! Reverted

Copy link
Member

@huan huan left a comment

Choose a reason for hiding this comment

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

LGTM

Thank you, @aherman3 , for adding this great getting started tutorial video play list to readme!

@aherman3 aherman3 requested a review from a team April 25, 2024 07:15
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.

3 participants