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

Update README.md #91

Merged
merged 1 commit into from
Jul 10, 2024
Merged

Update README.md #91

merged 1 commit into from
Jul 10, 2024

Conversation

alenbaby13
Copy link
Contributor

@alenbaby13 alenbaby13 commented Jul 3, 2024

Ticket Link


Related Links


Description


Steps to Reproduce / Test



Checklist

  • PR description included
  • yarn test passes
  • Tests are [changed or added]
  • Relevant documentation is changed or added (and PR referenced)

GIF's


Summary by CodeRabbit

  • Documentation
    • Updated URLs in the README file to improve tracking and attribution by pointing to wednesday.is with new query parameters.

Copy link

coderabbitai bot commented Jul 3, 2024

Walkthrough

This update in the nodejs-hapi-template repository primarily involves modifying URLs in the README.md file to optimize tracking. The URLs now point to the wednesday.is website with updated query parameters for better source attribution.

Changes

File Change Summary
README.md Updated links to wednesday.is with new query parameters for source tracking.

Poem

In the code where URLs dance,
They lead us now, a newer chance.
To Wednesday's site, they gently flow,
Enhanced with queries, watch them glow.
Tracking sources with precise aim,
The templates shine, no two the same.
🌐✨🐇

Tip

AI model upgrade

gpt-4o model for reviews and chat is now live

OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our Discord Community to provide any feedback or to report any issues.


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

@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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b31379a and a3234cd.

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

1-1: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


5-5: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

Additional comments not posted (2)
README.md (2)

4-4: Update URL for tracking purposes.

The URL has been updated to reflect the correct source and medium parameters for tracking purposes. This change seems appropriate and consistent with the objective.


25-25: Update URL for tracking purposes.

The URL has been updated to reflect the correct source and medium parameters for tracking purposes. This change seems appropriate and consistent with the objective.

@@ -1,7 +1,7 @@
<img align="left" src="https://github.com/wednesday-solutions/nodejs-hapi-template/blob/main/nodejs_hapi_template_github.svg" width="480" height="560" />
Copy link

Choose a reason for hiding this comment

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

Add alternate text for images.

Images should have alternate text (alt text) to improve accessibility and SEO.

- <img align="left" src="https://github.com/wednesday-solutions/nodejs-hapi-template/blob/main/nodejs_hapi_template_github.svg" width="480" height="560" />
+ <img align="left" src="https://github.com/wednesday-solutions/nodejs-hapi-template/blob/main/nodejs_hapi_template_github.svg" width="480" height="560" alt="Nodejs Hapi Template" />

- <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f5879492fafecdb3e5b0e75_wednesday_logo.svg">
+ <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f5879492fafecdb3e5b0e75_wednesday_logo.svg" alt="Wednesday Logo">

- <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f6ae88b9005f9ed382fb2a5_button_get_in_touch.svg" width="121" height="34">
+ <img src="https://uploads-ssl.webflow.com/5ee36ce1473112550f1e1739/5f6ae88b9005f9ed382fb2a5_button_get_in_touch.svg" width="121" height="34" alt="Get in Touch">

Also applies to: 5-5, 26-26

Tools
Markdownlint

1-1: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

@alichherawalla alichherawalla merged commit b48d80c into main Jul 10, 2024
2 of 3 checks passed
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.

2 participants