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

Framework comparison updates #997

Merged
merged 3 commits into from
Jun 5, 2024
Merged

Conversation

mitschabaude
Copy link
Contributor

@mitschabaude mitschabaude commented Jun 5, 2024

This removes code quotes and applies other small editorial changes

Copy link

vercel bot commented Jun 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 5, 2024 9:22am
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
07-oracles ⬜️ Ignored (Inspect) Visit Preview Jun 5, 2024 9:22am


Developers building `zkApps` in the `Mina ecosystem` can leverage a variety of specialized frameworks, each tailored to optimize different types of solutions.
This documentation selection ensures that you can select the most suitable framework to meet the unique demands of your project.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

It was unclear to me what "this documentation selection" was supposed to mean. I removed the sentence since i felt the intro was too verbose and the next sentence captures the same message already


If you are unsure about any of the information presented here and need guidance on choosing the most suitable framework for you, drop by [Discord](https://discord.gg/minaprotocol) and let us help!

## [o1js](/zkapps/o1js)

`o1js` is the framework used for building `zkApps` on the `Mina L1` and new infrastructure such as `rollups`.
o1js is Typescript based for ease of use, comes with a host of built-in features, is extensible to suit various use cases, and takes full advantage of the unique aspects of the Mina protocol.
o1js is the framework for building **zkApps on the Mina L1** and new infrastructure such as rollups.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

instead of code quotes, I'm using bold highlighting here and there

- Where more than the eight on-chain field elements are required to manage state, and access to that state is not shared, the experimental `Off-chain Storage API` will suffice.
- Where `concurrent` access to `shared state` is required, this architecture is available "**out of the box**", when using the `Protokit` framework to build your zkApp as an zkApp-chain (L2).
- Where more than the eight on-chain field elements are required to manage state, and access to that state is not shared between users, the experimental [Offchain Storage API](/zkapps/writing-a-zkapp/feature-overview/offchain-storage) offers a solution.
- Where concurrent access to _shared global state_ is required, the required architecture is available **out of the box** when using the Protokit framework to build your zkApp as an zkApp-chain (L2). There is currently no easy-to-use equivalent for shared state in o1js L1 contracts.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

added the last sentence for clarity

@mitschabaude mitschabaude marked this pull request as ready for review June 5, 2024 09:18
@mitschabaude mitschabaude requested a review from a team as a code owner June 5, 2024 09:18
@mitschabaude mitschabaude merged commit ad2dd21 into main Jun 5, 2024
4 checks passed
@mitschabaude mitschabaude deleted the docs/zkapps-intro-polishing branch June 5, 2024 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants