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.

Sign up for GitHub

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

Jump to bottom

Update README.md for Canva blog #1173

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md for Canva blog #1173

wants to merge 1 commit into from

Conversation

vikram-canva
Copy link

@vikram-canva vikram-canva commented Oct 19, 2024 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Documentation
    • Updated the "Companies" section in the README.md with new entries and revised URLs for improved accuracy.
    • Maintained the structure and layout of the documentation for consistency.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Oct 19, 2024 •
edited
Loading

Walkthrough

The changes in this pull request primarily involve modifications to the README.md file. These include updates to the content and structure of sections that list companies, individuals, and technologies relevant to software engineering blogs. Notably, the URL for Canva was changed, enhancing the accuracy of the resources provided. The overall format of the tables remains unchanged, and other sections such as "RSS feeds," "Contributing," and "License" were retained without modifications.

Changes

File Change Summary
README.md Updated Canva URL in "C companies" section from https://engineering.canva.com to https://canva.dev/blog/engineering/; added new entries and updated existing links in the companies section. No changes to table headers or layout, and other sections remain unchanged.

Poem

In the README's embrace,
Links dance with a fresh face,
Canva's path now leads the way,
To a blog where insights play.
With each update, we refine,
A treasure trove of tech, divine! 🐇✨

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

coderabbitai[bot]
coderabbitai bot reviewed Oct 19, 2024
View reviewed changes
Copy link

@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

🧹 Outside diff range and nitpick comments (1)
README.md (1)

58-58: Approve URL update and suggest minor formatting improvement.

The update to Canva's engineering blog URL is correct and aligns with the PR objectives. However, to maintain consistency with markdown best practices and address the static analysis hint, I suggest wrapping the URL in angle brackets:

-* Canva https://canva.dev/blog/engineering/
+* Canva <https://canva.dev/blog/engineering/>

This change will resolve the bare URL issue (MD034) flagged by markdownlint.

🧰 Tools
🪛 Markdownlint

58-58: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 50eab27 and 2f37cc3.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
README.md

58-58: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
README.md (1)

Line range hint 1-1173: Summary of changes

The primary change in this PR is the update of Canva's engineering blog URL, which has been successfully implemented. No other significant modifications were observed in the provided diff. The change aligns well with the PR objectives.

A minor formatting suggestion has been made to improve consistency and address a static analysis hint. Overall, this is a straightforward and beneficial update to the README.md file.

🧰 Tools
🪛 Markdownlint

55-55: null
Bare URL used

(MD034, no-bare-urls)

58-58: null
Bare URL used

(MD034, no-bare-urls)

59-59: null
Bare URL used

(MD034, no-bare-urls)

60-60: null
Bare URL used

(MD034, no-bare-urls)

61-61: null
Bare URL used

(MD034, no-bare-urls)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@vikram-canva