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: new experimental topic with channel to give feedback #563

Merged
merged 8 commits into from
Aug 24, 2023
29 changes: 29 additions & 0 deletions docs/zkapps/experimental.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: Experimental features
description: Experimental features are not considered production-ready.
keywords:
- experimental
- feedback
---

# Experimental features

Some new features are considered experimental before they are production-ready.

Exposing experimental features gives you an opportunity to try our newest features sooner.

In return, your feedback helps us make sure that our new features are reliable and useful.

## Feedback

We appreciate any and all feedback you want to provide.

The best place to provide feedback and ask questions is on [Mina Protocol Discord](https://bit.ly/MinaDiscord).

To ask zkApps questions and engage with other developers building zkApps with SnarkyJS, use the [#zkapps-developers](https://discord.com/channels/484437221055922177/915745847692636181) channel.

Experimental features are in active development and your feedback is especially appreciated.

- The feature may have bugs
- The feature may be changed, deprecated, or removed
- Any documentation for the feature explicitly notes the feature is experimental
4 changes: 2 additions & 2 deletions docs/zkapps/snarkyjs/recursion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ zkApp programmability is not yet available on the Mina Mainnet. You can get star

:::

Experimental. This API may change.
[Experimental](/zkapps/experimental). This API may change.

Specifically, we are looking into refactoring ZkProgram methods to explicitly return values rather than requiring them to be passed as further inputs.
Specifically, ZkProgram methods could be refactored to explicitly return values rather than requiring them to be passed as further inputs.

# Recursion

Expand Down
4 changes: 2 additions & 2 deletions docs/zkapps/snarkyjs/smart-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ keywords:

:::info

Experimental. This API may change.
[Experimental](/zkapps/experimental). This API may change.

Specifically, we are looking into refactoring ZkProgram methods to explicitly return values rather than requiring them to be passed as further inputs.
Specifically, ZkProgram methods could be refactored to explicitly return values rather than requiring them to be passed as further inputs.

:::

Expand Down
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@ module.exports = {
},
'zkapps/roadmap',
'zkapps/faq',
'zkapps/experimental',
'zkapps/zkapps-for-ethereum-developers',
],
},
Expand Down
Loading