Skip to content

Commit

Permalink
Merge pull request #563 from o1-labs/experimental
Browse files Browse the repository at this point in the history
docs: new experimental topic with channel to give feedback
  • Loading branch information
barriebyron authored Aug 24, 2023
2 parents 6f40d98 + 0cc1f3b commit 339e405
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 4 deletions.
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

1 comment on commit 339e405

@vercel
Copy link

@vercel vercel bot commented on 339e405 Aug 24, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

docs2 – ./

docs2-git-main-minadocs.vercel.app
docs.minaprotocol.com
docs2-minadocs.vercel.app

Please sign in to comment.