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

chore(docs): documenting reference, how-to and explainer on the usage of oracles #4002

Merged
merged 14 commits into from
Jan 16, 2024

Conversation

signorecello
Copy link
Contributor

Description

This PR adds some more in-depth documentation on oracles, what they are and how to use them.

Problem*

Closes #3971

Oracles can now be resolved with JSON RPC calls, which is a powerful feature for developers. This PR attempts to provide some information on how they can be part of a development flow

Summary*

  • Adds the nargo commands for oracles
  • Adds an explainer on what are oracles and what can you do with them
  • Adds a how-to guide on using oracles
  • Adds a tutorial on a small project using oracles

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 10, 2024
Copy link
Contributor

github-actions bot commented Jan 11, 2024

@signorecello
Copy link
Contributor Author

Superseeds #3975

@signorecello signorecello changed the title chore(docs): adding an WIP explainer and how-to on oracles chore(docs): documenting reference, how-to and explainer on the usage of oracles Jan 12, 2024
@signorecello signorecello marked this pull request as ready for review January 12, 2024 11:34
@signorecello signorecello requested review from sirasistant and a team January 12, 2024 11:34
@signorecello
Copy link
Contributor Author

I think this is in a good spot for reviewing

docs/docs/how_to/how-to-oracles.md Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/noir/concepts/oracles.md Outdated Show resolved Hide resolved
docs/docs/noir/concepts/oracles.md Show resolved Hide resolved
docs/docs/reference/NoirJS/noir_js/index.md Outdated Show resolved Hide resolved
docs/docs/reference/NoirJS/backend_barretenberg/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Savio-Sou Savio-Sou left a comment

Choose a reason for hiding this comment

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

Minor nits.

docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/explainers/explainer-oracle.md Outdated Show resolved Hide resolved
docs/docs/how_to/how-to-oracles.md Outdated Show resolved Hide resolved
docs/docs/how_to/how-to-oracles.md Outdated Show resolved Hide resolved
docs/docs/reference/NoirJS/noir_js/index.md Outdated Show resolved Hide resolved
docs/docs/reference/NoirJS/noir_js/index.md Outdated Show resolved Hide resolved
docs/docs/reference/NoirJS/noir_js/index.md Outdated Show resolved Hide resolved
signorecello and others added 2 commits January 14, 2024 12:52
Co-authored-by: Savio <72797635+Savio-Sou@users.noreply.github.com>
Co-authored-by: josh crites <jc@joshcrites.com>
Copy link
Contributor

@sirasistant sirasistant left a comment

Choose a reason for hiding this comment

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

Just one typo!

docs/docs/how_to/how-to-oracles.md Outdated Show resolved Hide resolved
Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

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

👍

@Savio-Sou Savio-Sou added this pull request to the merge queue Jan 16, 2024
Merged via the queue into master with commit d6a16d0 Jan 16, 2024
30 checks passed
@Savio-Sou Savio-Sou deleted the zpedro/oracles branch January 16, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the #[oracle] attribute
4 participants