From 7f5564bba4233ad811e4b9b3a061ba1a329d230e Mon Sep 17 00:00:00 2001 From: barriebyron Date: Tue, 15 Aug 2023 13:36:19 -0400 Subject: [PATCH 1/7] new experimental topic with channel to give feedback --- docs/experimental.mdx | 27 +++++++++++++++++++++++++++ sidebars.js | 1 + 2 files changed, 28 insertions(+) create mode 100644 docs/experimental.mdx diff --git a/docs/experimental.mdx b/docs/experimental.mdx new file mode 100644 index 000000000..b98eb437a --- /dev/null +++ b/docs/experimental.mdx @@ -0,0 +1,27 @@ +--- +title: Experimental features +description: Experimental features are not considered production-ready. +keywords: + - experimental + - feedback +--- + +# Experimental features + +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]. + +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 diff --git a/sidebars.js b/sidebars.js index e3892dc25..ec5192272 100644 --- a/sidebars.js +++ b/sidebars.js @@ -404,5 +404,6 @@ module.exports = { ], }, 'glossary', + 'experimental', ], }; From ca7751842f0fb7ad90f6bfdab123c85797ef29a6 Mon Sep 17 00:00:00 2001 From: barriebyron Date: Tue, 15 Aug 2023 14:02:00 -0400 Subject: [PATCH 2/7] proposed new topic for experimental channels --- docs/experimental.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/experimental.mdx b/docs/experimental.mdx index b98eb437a..5ca02ca1d 100644 --- a/docs/experimental.mdx +++ b/docs/experimental.mdx @@ -18,7 +18,7 @@ In return, your feedback helps us make sure that our new features are reliable a 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]. +The best place to provide feedback and ask questions is on [Mina Protocol Discord](https://bit.ly/MinaDiscord). Experimental features are in active development and your feedback is especially appreciated. From 00513922db91304b3928e43a8ff2445f70234782 Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Thu, 17 Aug 2023 12:26:45 -0400 Subject: [PATCH 3/7] Update docs/experimental.mdx --- docs/experimental.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/experimental.mdx b/docs/experimental.mdx index 5ca02ca1d..cb35c37db 100644 --- a/docs/experimental.mdx +++ b/docs/experimental.mdx @@ -20,6 +20,8 @@ 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 provide feedback and ask questions on experimental features in zkApps, 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 From f94253d75a2739a9efb56592a9238215348bfcbe Mon Sep 17 00:00:00 2001 From: Barrie Byron Date: Thu, 17 Aug 2023 12:45:27 -0400 Subject: [PATCH 4/7] move experimental into zkApps doc section --- sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sidebars.js b/sidebars.js index ec5192272..b77ae9af8 100644 --- a/sidebars.js +++ b/sidebars.js @@ -330,6 +330,7 @@ module.exports = { }, 'zkapps/roadmap', 'zkapps/faq', + 'zkapps/experimental', 'zkapps/zkapps-for-ethereum-developers', ], }, @@ -404,6 +405,5 @@ module.exports = { ], }, 'glossary', - 'experimental', ], }; From 79187a4d490461bcc461d70807fce21f23c3ae4a Mon Sep 17 00:00:00 2001 From: barriebyron Date: Thu, 17 Aug 2023 12:49:09 -0400 Subject: [PATCH 5/7] move experimental out of main TOC and into nexted zkApps section --- docs/{ => zkapps}/experimental.mdx | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{ => zkapps}/experimental.mdx (100%) diff --git a/docs/experimental.mdx b/docs/zkapps/experimental.mdx similarity index 100% rename from docs/experimental.mdx rename to docs/zkapps/experimental.mdx From adf2c1cbf5d4bb4c07734c9f7adb500b61b19c8b Mon Sep 17 00:00:00 2001 From: barriebyron Date: Thu, 17 Aug 2023 13:09:45 -0400 Subject: [PATCH 6/7] add links from experimental notes in docs to the new topic --- docs/zkapps/experimental.mdx | 2 +- docs/zkapps/snarkyjs/recursion.mdx | 4 ++-- docs/zkapps/snarkyjs/smart-contracts.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/zkapps/experimental.mdx b/docs/zkapps/experimental.mdx index cb35c37db..9644aa046 100644 --- a/docs/zkapps/experimental.mdx +++ b/docs/zkapps/experimental.mdx @@ -20,7 +20,7 @@ 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 provide feedback and ask questions on experimental features in zkApps, use the [#zkapps-developers](https://discord.com/channels/484437221055922177/915745847692636181) channel. +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. diff --git a/docs/zkapps/snarkyjs/recursion.mdx b/docs/zkapps/snarkyjs/recursion.mdx index ad440da88..61b57b938 100644 --- a/docs/zkapps/snarkyjs/recursion.mdx +++ b/docs/zkapps/snarkyjs/recursion.mdx @@ -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 diff --git a/docs/zkapps/snarkyjs/smart-contracts.md b/docs/zkapps/snarkyjs/smart-contracts.md index 8150f5c6f..4550bfea9 100644 --- a/docs/zkapps/snarkyjs/smart-contracts.md +++ b/docs/zkapps/snarkyjs/smart-contracts.md @@ -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. ::: From 3bb3a692ea72d5fb9e20b236ec9eacd615ff8e5a Mon Sep 17 00:00:00 2001 From: barriebyron Date: Thu, 17 Aug 2023 13:37:44 -0400 Subject: [PATCH 7/7] some new features, not all --- docs/zkapps/experimental.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/zkapps/experimental.mdx b/docs/zkapps/experimental.mdx index 9644aa046..0e47355a6 100644 --- a/docs/zkapps/experimental.mdx +++ b/docs/zkapps/experimental.mdx @@ -8,7 +8,7 @@ keywords: # Experimental features -New features are considered experimental before they are production-ready. +Some new features are considered experimental before they are production-ready. Exposing experimental features gives you an opportunity to try our newest features sooner.