Update docs with adding a new halo2 circuit in 'mopro-wam' #292

sifnoc · 2025-01-09T13:38:19Z

Added more item in prerequisite page
Describe how to add a new halo2 circuit implementation on mopro-wasm

vivianjeng · 2025-01-10T05:49:30Z

docs/docs/prerequisites.md

    -   [Android Studio](https://developer.android.com/studio)
    -   Also see [configuration](#android-configuration) below
+    -   [JDK(Java Development Kit)](https://www.oracle.com/java/technologies/downloads)


I think we can switch the order to

Android Studio

JDK

Also see configuration

because when a user see below, he will miss the JDK

vivianjeng · 2025-01-10T05:55:51Z

docs/docs/setup/web-wasm-setup.md

+
+Follow these steps to update and build the user-defined circuit implementation for Wasm:
+
+1. **Update `Cargo.toml` in 'mopro-wasm'**


I think the users should use mopro-wasm-lib (in mopro-example-app) instead of mopro-wasm in zkmopro.

Because in the future, the users don't need to clone the repo zkmopro/mopro and they can use CLI
(I think we should support mopro binary for users to use mopro CLI
like circom, they support binaries
so they don't need to clone the repo and use the binary)

we should let users know how to generate bindings with rust setup
like in Flutter setup or React Native setup
(Just redirect them to rust setup and choose web as target)

I think the users should use mopro-wasm-lib (in mopro-example-app) instead of mopro-wasm in zkmopro.

For align consistancy with other setup doc, we should add create mopro-wasm-lib like "setup the rust project" in Rust setup and remove the "Proving from web browser" section :https://zkmopro.org/docs/setup/web-wasm-setup#proving-from-web-browser.
What do you think?

Because in the future, the users don't need to clone the repo zkmopro/mopro and they can use CLI (I think we should support mopro binary for users to use mopro CLI like circom, they support binaries so they don't need to clone the repo and use the binary)

I totally agree. but currently only simple doc "Getting Started" for about how to setup with the mopro cli.

For align consistancy with other setup doc, we should add create mopro-wasm-lib like "setup the rust project" in Rust setup and remove the "Proving from web browser" section :https://zkmopro.org/docs/setup/web-wasm-setup#proving-from-web-browser.
What do you think?

We should let user simply uses mopro init, mopro build for web
and he will find mopro-wasm-lib within the folder
(I realized that we should update react native setup and flutter setup, and guide them to look Getting Started section instead of Rust Setup section)
and yes we can remove the "Proving from web browser" section

Looks good! I will update other setup docs that to rely on using mopro cli instead of starting with Rust Setup page.

docs/docs/setup/web-wasm-setup.md

…equisites page

…ust setup' page

cloudflare-workers-and-pages · 2025-01-13T13:30:56Z

Deploying mopro with Cloudflare Pages

Latest commit:	`93f0f4a`
Status:	✅ Deploy successful!
Preview URL:	https://78b7558c.mopro.pages.dev
Branch Preview URL:	https://updating-doc-2025-1.mopro.pages.dev

View logs

sifnoc · 2025-01-13T13:47:08Z

Now the Rust Setup page renamed as Manual Setup for Android/iOS Bindings for accuracy.
Moved the page item at the last in the side-bar. it looks more last option than using mopro cli
Added setup Halo2-based rust project alongside with Circom-based rust project: which was only the content in the Rust Setup

vivianjeng

The current version looks good to me! Thank you!

can you also update the doc in versioned_doc/version-0.1.0?
It is confusing to have 2 docs
but one is for current version (0.1.0) and the other is for the next version (might be0.2.0)
so just copy the current files in docs/ and paste to version-0.1.0/

also the mopro-wasm should be copied to docs/ too
Thank you

docs/docs/setup/flutter-setup.md

docs/docs/setup/react-native-setup.md

docs/docs/setup/rust-setup.md

docs/docs/setup/web-wasm-setup.md

vivianjeng · 2025-01-14T03:42:45Z

and there is an error in cloudflare

00:38:30.251 | [cause]: Error: Docusaurus found broken links!
-- | --
00:38:30.251 |  
00:38:30.251 | Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
00:38:30.251 | Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
00:38:30.252 |  
00:38:30.252 | Exhaustive list of all broken links found:
00:38:30.252 | - Broken link on source page path = /docs/next/setup/react-native-setup:
00:38:30.252 | -> linking to docs/react-native-setup#option-1-use-mopro-cli (resolved as: /docs/next/setup/docs/react-native-setup#option-1-use-mopro-cli)
00:38:30.252 |  
00:38:30.252 | at throwError (/opt/buildhome/repo/docs/.yarn/cache/@docusaurus-logger-npm-3.2.1-11923e9c7b-9d5db5253e.zip/node_modules/@docusaurus/logger/lib/index.js:79:11)
00:38:30.252 | at reportBrokenLinks (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/server/brokenLinks.js:242:47)
00:38:30.252 | at handleBrokenLinks (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/server/brokenLinks.js:274:5)
00:38:30.253 | at executeBrokenLinksCheck (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/commands/build.js:182:47)
00:38:30.253 | at /opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/commands/build.js:136:66
00:38:30.253 | at Object.async (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/utils.js:36:47)
00:38:30.253 | at buildLocale (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/commands/build.js:136:30)
00:38:30.253 | at async tryToBuildLocale (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/commands/build.js:46:13)
00:38:30.253 | at async /opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/commands/build.js:64:9
00:38:30.253 | at async mapAsyncSequential (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-utils-virtual-daa5b7b8bd/0/cache/@docusaurus-utils-npm-3.2.1-cfade3be35-ea862b178e.zip/node_modules/@docusaurus/utils/lib/jsUtils.js:20:24)
00:38:30.253 | at async Command.build (/opt/buildhome/repo/docs/.yarn/__virtual__/@docusaurus-core-virtual-0694d71873/0/cache/@docusaurus-core-npm-3.2.1-027b2f9feb-9267f08b41.zip/node_modules/@docusaurus/core/lib/commands/build.js:62:5)

You can check by

cd docs && yarn build

to get the error

docs/docs/setup/react-native-setup.md

sifnoc · 2025-01-14T05:53:20Z

The current version looks good to me! Thank you!

can you also update the doc in versioned_doc/version-0.1.0? It is confusing to have 2 docs but one is for current version (0.1.0) and the other is for the next version (might be0.2.0) so just copy the current files in docs/ and paste to version-0.1.0/

also the mopro-wasm should be copied to docs/ too Thank you

Synced at last two commits: 270f9df 93f0f4a

vivianjeng

LGTM!
Thank you so much!

vivianjeng reviewed Jan 10, 2025

View reviewed changes

sifnoc added 3 commits January 10, 2025 08:28

docs: added 'mopro-wasm' page in v0.1.0 and iOS configuration in prer…

fdd3de5

…equisites page

docs: Updated adding new circuit for mopro-wasm

fd78b72

docs: Updated setup pages with using mopro cli instead of based on 'R…

37f5b74

…ust setup' page

sifnoc force-pushed the updating-doc-2025-1 branch from ee756fb to 37f5b74 Compare January 13, 2025 13:30

sifnoc requested a review from vivianjeng January 13, 2025 13:47

fix: Using mopro cli for updating circuit for web wasm bindings

fcd3572

vivianjeng reviewed Jan 14, 2025

View reviewed changes

docs/docs/setup/react-native-setup.md Outdated Show resolved Hide resolved

sifnoc added 3 commits January 14, 2025 05:46

fix: updated follows review feedback

8693285

docs: updated v0.1.0 version docs with next(latest updates)

270f9df

fix: sync sidebar updated with latest doc

93f0f4a

vivianjeng approved these changes Jan 16, 2025

View reviewed changes

vivianjeng merged commit e424efd into main Jan 16, 2025
35 checks passed

vivianjeng deleted the updating-doc-2025-1 branch January 16, 2025 07:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs with adding a new halo2 circuit in 'mopro-wam' #292

Update docs with adding a new halo2 circuit in 'mopro-wam' #292

sifnoc commented Jan 9, 2025

vivianjeng Jan 10, 2025

vivianjeng Jan 10, 2025

vivianjeng Jan 10, 2025

sifnoc Jan 10, 2025

vivianjeng Jan 10, 2025

sifnoc Jan 10, 2025

cloudflare-workers-and-pages bot commented Jan 13, 2025 •

edited

Loading

sifnoc commented Jan 13, 2025

vivianjeng left a comment

vivianjeng commented Jan 14, 2025

sifnoc commented Jan 14, 2025

vivianjeng left a comment


		Follow these steps to update and build the user-defined circuit implementation for Wasm:

		1. Update `Cargo.toml` in 'mopro-wasm'

Update docs with adding a new halo2 circuit in 'mopro-wam' #292

Update docs with adding a new halo2 circuit in 'mopro-wam' #292

Conversation

sifnoc commented Jan 9, 2025

vivianjeng Jan 10, 2025

Choose a reason for hiding this comment

vivianjeng Jan 10, 2025

Choose a reason for hiding this comment

vivianjeng Jan 10, 2025

Choose a reason for hiding this comment

sifnoc Jan 10, 2025

Choose a reason for hiding this comment

vivianjeng Jan 10, 2025

Choose a reason for hiding this comment

sifnoc Jan 10, 2025

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented Jan 13, 2025 • edited Loading

Deploying mopro with Cloudflare Pages

sifnoc commented Jan 13, 2025

vivianjeng left a comment

Choose a reason for hiding this comment

vivianjeng commented Jan 14, 2025

sifnoc commented Jan 14, 2025

vivianjeng left a comment

Choose a reason for hiding this comment

cloudflare-workers-and-pages bot commented Jan 13, 2025 •

edited

Loading