docs icon indicating copy to clipboard operation
docs copied to clipboard

adding ORA to oracles.mdx

Open Gwen-M opened this issue 1 year ago • 2 comments

Description

Adding the details & features of ORA Oracle.

Tests

No test needed as it's just some additions to an .mdx page.

Additional context

ORA is part of the Optimism ecosystem and the RPGF program.

Metadata

  • Fixes #[Link to Issue]

Gwen-M avatar Aug 14 '24 08:08 Gwen-M

Walkthrough

The recent update introduces a new section dedicated to the ORA protocol, an Ethereum-based AI oracle system. This section details the Onchain AI Oracle (OAO), its features, and the structure of the ORA Oracle Network. It emphasizes the decentralized nature of the network and provides resources for developers to leverage AI in their smart contracts, enhancing the document's utility for potential users.

Changes

Files Change Summary
pages/builders/tools/build/oracles.mdx Added a new section on ORA, covering the Onchain AI Oracle (OAO), its features, network structure, and developer resources.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SmartContract
    participant ORAOracle
    participant NodeOperator

    User->>SmartContract: Initiates transaction
    SmartContract->>ORAOracle: Requests AI data
    ORAOracle->>NodeOperator: Dispatch computation request
    NodeOperator->>ORAOracle: Executes computation with verifiable proof
    ORAOracle->>SmartContract: Returns AI inference
    SmartContract->>User: Provides transaction result

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.

coderabbitai[bot] avatar Aug 14 '24 08:08 coderabbitai[bot]

Deploy Preview for docs-optimism ready!

Name Link
Latest commit 27a429db3ed9ccff35ad06be754a8afcbfaf1736
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66bc6e53a01d2c0008579d5a
Deploy Preview https://deploy-preview-827--docs-optimism.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Aug 14 '24 08:08 netlify[bot]

Can you make a PR to our community docs, i am closing this.

krofax avatar Aug 27 '24 12:08 krofax