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

docs: add link to live demo #39

Merged
merged 1 commit into from
Jul 1, 2024
Merged

docs: add link to live demo #39

merged 1 commit into from
Jul 1, 2024

Conversation

jo-elimu
Copy link
Member

@jo-elimu jo-elimu commented Jul 1, 2024

No description provided.

@jo-elimu jo-elimu self-assigned this Jul 1, 2024
@jo-elimu jo-elimu requested a review from a team as a code owner July 1, 2024 07:54
Copy link

coderabbitai bot commented Jul 1, 2024

Walkthrough

The README.md file was updated to include links to a live demo and a video demo for a decentralized application (Dapp) that sponsors the education of a child. These changes provide users with immediate access to visual demonstrations of the application's functionality.

Changes

File Change Summary
README.md Added links to a live demo and a video demo.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant README
    User ->> README: Access README
    README -->> User: Show live demo link
    README -->> User: Show video demo link
    User ->> LiveDemoLink: Click link for live demo
    Note right of User: Opens the live demo in a new tab
    User ->> VideoDemoLink: Click link for video demo
    Note right of User: Opens the video demo in a new tab
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c60cdde and 79c3452.

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

5-5: null
Bare URL used

(MD034, no-bare-urls)


7-7: null
Bare URL used

(MD034, no-bare-urls)


Tip

Early access features: enabled

We are currently testing the following features in early access:

  • OpenAI gpt-4o model for code reviews and chat: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available.

Note:

  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
  • Please join our Discord Community to provide feedback and report issues.
  • OSS projects are currently opted into early access features by default.

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

netlify bot commented Jul 1, 2024

Deploy Preview for web3-sponsors canceled.

Name Link
🔨 Latest commit 79c3452
🔍 Latest deploy log https://app.netlify.com/sites/web3-sponsors/deploys/668260c14ecd530008ea4e1f

@jo-elimu jo-elimu merged commit 535e301 into main Jul 1, 2024
12 checks passed
@jo-elimu jo-elimu deleted the docs-live-demo branch July 1, 2024 07:57
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: 2

@@ -2,4 +2,6 @@

Dapp for sponsoring the education of one individual child

Live demo: https://sponsors.elimu.ai
Copy link

Choose a reason for hiding this comment

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

Format the URL as a Markdown link.

The live demo URL is a bare URL. To comply with Markdown linting rules (MD034), it should be formatted as a Markdown link.

- Live demo: https://sponsors.elimu.ai
+ [Live demo](https://sponsors.elimu.ai)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Live demo: https://sponsors.elimu.ai
Live demo: [Live demo](https://sponsors.elimu.ai)
Tools
Markdownlint

5-5: null
Bare URL used

(MD034, no-bare-urls)

@@ -2,4 +2,6 @@

Dapp for sponsoring the education of one individual child

Live demo: https://sponsors.elimu.ai

Video demo: https://www.loom.com/share/4ca573012b1e4935a4870588c3b5c20d?sid=7fe1fa45-3ace-48f2-b2d6-0f8b0f5e195e
Copy link

Choose a reason for hiding this comment

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

Format the URL as a Markdown link.

The video demo URL is a bare URL. To comply with Markdown linting rules (MD034), it should be formatted as a Markdown link.

- Video demo: https://www.loom.com/share/4ca573012b1e4935a4870588c3b5c20d?sid=7fe1fa45-3ace-48f2-b2d6-0f8b0f5e195e
+ [Video demo](https://www.loom.com/share/4ca573012b1e4935a4870588c3b5c20d?sid=7fe1fa45-3ace-48f2-b2d6-0f8b0f5e195e)
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Video demo: https://www.loom.com/share/4ca573012b1e4935a4870588c3b5c20d?sid=7fe1fa45-3ace-48f2-b2d6-0f8b0f5e195e
Video demo: [Video demo](https://www.loom.com/share/4ca573012b1e4935a4870588c3b5c20d?sid=7fe1fa45-3ace-48f2-b2d6-0f8b0f5e195e)
Tools
Markdownlint

7-7: 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants