Skip to content

Commit

Permalink
chore: standardize experimental feature disclaimer across documentati…
Browse files Browse the repository at this point in the history
…on (noir-lang#5367)

# Description

## Problem\*

Resolves noir-lang#4935

## Summary\*

This pull request makes the experimental feature warnings the same
across different parts of the documentation. I've created one warning
message that all pages can show. This helps in keeping the docs
consistent and easy to update.

## Additional Context

The new disclaimer meets all the requirements set out in issue noir-lang#4935 by:
- Clearly stating that the feature is experimental;
- Noting that the documentation may be incomplete or out of date, and
thus subject to changes that could impact its behavior or functionality;
- Encouraging contributions and providing a direct link to the project's
GitHub repository.

## Documentation\*

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[For Experimental Features]** Documentation to be submitted in a
separate PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [ ] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
  • Loading branch information
joaolago1113 authored Jul 16, 2024
1 parent 951e821 commit 6983b24
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
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
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
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).

:::

0 comments on commit 6983b24

Please sign in to comment.