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

chore: standardize experimental feature disclaimer across documentation #5367

Merged
merged 1 commit into from
Jul 16, 2024
Merged

chore: standardize experimental feature disclaimer across documentation #5367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/docs/noir/concepts/data_bus.md → docs/docs/noir/concepts/data_bus.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
title: Data Bus
sidebar_position: 13
---
**Disclaimer** this feature is experimental, do not use it!
import Experimental from '@site/src/components/Notes/_experimental.mdx';

<Experimental />

The data bus is an optimization that the backend can use to make recursion more efficient.
In order to use it, you must define some inputs of the program entry points (usually the `main()`
Expand Down
6 changes: 2 additions & 4 deletions docs/docs/noir/concepts/oracles.md → docs/docs/noir/concepts/oracles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,9 @@ keywords:
sidebar_position: 6
---

:::note
import Experimental from '@site/src/components/Notes/_experimental.mdx';

This is an experimental feature that is not fully documented. If you notice any outdated information or potential improvements to this page, pull request contributions are very welcome: https://github.com/noir-lang/noir

:::
<Experimental />

Noir has support for Oracles via RPC calls. This means Noir will make an RPC call and use the return value for proof generation.

Expand Down
7 changes: 4 additions & 3 deletions docs/src/components/Notes/_experimental.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
:::caution
:::caution Experimental Feature

This feature is experimental. You should expect it to change in future versions,
cause unexpected behavior, or simply not work at all.
This feature is experimental. The documentation may be incomplete or out of date, which means it could change in future versions, potentially causing unexpected behavior or not working as expected.

**Contributions Welcome:** If you notice any inaccuracies or potential improvements, please consider contributing. Visit our GitHub repository to make your contributions: [Contribute Here](https://github.com/noir-lang/noir).

:::
Loading