minaprotocol / docs Goto Github PK

Docker and non-Docker steps are mixed together. Separate Docker instructions into its own page.

1. When hovering over a section header, show an an icon to the right of the header. Probably something like chain icon or #.
2. Clicking this should change the URL to this deep link--e.g. docs.minaprotocol.com/page#an-interesting-section

Probably via algolia.

This might not be easy, but would help users know where they are on the site.

I think it should be minaprotocol/generate-keypair instead of minaprotocol/mina-generate-keypair.

For the currently live docs. Just a quick pass to bright up some of the purples, greens, etc so it's more readable.

Easy issue. Just a short paragraph documenting it to explain how to include them and to clarify that 3rd party libraries can be used with SnarkyJS.

Include info box encouraging others to label their projects a certain way on NPM for better discovery? To discuss.

Related: https://github.com/minaprotocol/docs

For network precondition and account precondition

on this page
https://docs.minaprotocol.com/en/architecture/consensus
the 'Local_state' has incomplete description/definition.

E.g.
I'm a user
I'm a node operator
I'm a node dev
I'm a SNAPPS dev
I'm an exchange

Or "For users", "For Node Operators", etc

1. Re-organize top level by use case.
2. Put FAQ in each section, where needed.
3. Other top level sections: glossary, FAQ?

Using local blockchain.

The documentation describes to validate the keypair using docker with this command:

docker run --interactive --tty --rm --volume $(pwd)/keys:/keys minaprotocol/mina-generate-keypair:1.3.0-9b0369c --privkey-path /keys/my-wallet

This however only generates the keypair. I can't find the correct image on https://hub.docker.com/u/minaprotocol so can't really propose a change here.

Similar to @ymekuria's existing instructions for React, at the bottom of the How to Write a zkApp page in the docs.

Probably just a short code snippet without much or any accompanying text.

vuejs.org

Problem Description

I found an image adaptation problem when I was reading the documentation, the specific location is: docs/pages/en/architecture/ Snarking Transactions

I'm looking at this image on a 14" Macbook which is huge and off screen

like this：

Description

• “fromJSON” for the bool class takes you to the right method because that's the first time the id for that method is usedon the page.
• Every class containing a “fromJSON” method link after that also takes you to “fromJSON” for the bool class instead of the class you'd expect (ex. PublicKey “fromJSON” links to => bool “fromJSON”).

To reproduce:

1. Visit bool class, click "fromJSON" in the bullet list of methods belonging to that class. It will jump to the correct fromJSON section.
2. Visit PublicKey class, click fromJSON. It will jump to the Bool class' fromJSON method, not the PublicKey's which we wanted.

From Brett.

We should ensure we are backing up archive data from devnet just like we do with mainnet -- all redundancy mechanisms plus periodically doing database dumps.

Gregor mentioned this needs to be updated, presumably for preconditions. Consider just briefly mentioning it and linking to the preconditions section for actual explanation.

Also, maybe not super easy, but useful for users to know where they are.

Could we indicate current page visually? A slightly thicker gray or orange line, orange text, etc?

The docs used to contain a broken link ofFees are handled out-of-band see the [fee excess system](#fee-excess). on the lifeycle-payment-technical.mdx draft docs. But such a section did not exist in the docs.

Is such a section useful & should it be added?

Discussion was in O(1)'s Slack.

Similar to @ymekuria's existing instructions for React, at the bottom of the How to Write a zkApp page in the docs.

Probably just a short code snippet without much or any accompanying text.

svelte.dev

Upgradeability & Admins

• Optional upgradeability & example code
• How to make a contract provably not upgradeable & example code (set admin to the 0 address)
• changeAdmins() method to add or remove admins from a list of allowed admins.

State

• Types of state & when to use each
• How to store state
• How to access state
• Metadata - what it is? why & how to use it? Recommended storage location (IPFS, etc). Recommended format.

Testing

• How to run tests: npm run test, npm run testw
• Example tests
• Links to docs for testing libs we use (Jest, their assertion lib, etc)
• How to generate coverage report: npm run coverage
• Explain Github CI is provided and benefits (free for open source projects like Mina zkApps too)

Building

• How to run build: npm run build and explain what this does

Publish / Sharing

• How to publish a zkApp smart contract to NPM

zkApp Examples

• Data verification + attestation

Circuits

• Public input vs private input. Explanation, characteristics, & when to use each.

Circuit Examples

Verifiable Randomness Function (VRF)

• What is it? What is it used for? (random outcomes like games & randomly selecting judges) How to use it?
  ...

Misc

• Discuss license of project template. Maybe in the CLI project's docs is best place?

At mobile sizes, the expanded menu is not scrollable within the viewport, which can cause parts of a long menu to become inaccessible.

Hello, hopefully I won't disturb anything by posting this issue.
While reading the economics white paper available from for the website, in noticed a type on page 7, paragraph Nomenclature and Denomination.
From the micromina, 1^-6 (equal to 1) should be replaced by 10^-6 (aqual to 0.000001)

Create a React component for each version # used in the docs.

This avoids using hard coding version #'s multiple times throughout the docs to provide one source of truth where a version # can be updated.

On this page: https://docs.minaprotocol.com/en try clicking the whitepaper links. They are missing

• https://minaprotocol.com/static/pdf/technicalWhitepaper.pdf - 404 not found, nginx
• https://minaprotocol.com/static/pdf/economicsWhitepaper.pdf - 404 not found, nginx

I was learning more about fees in Mina network and came across this page:

https://docs.minaprotocol.com/en/architecture/lifecycle-payment-technical

In the part with "Fees are handled out-of-band see the fee excess system" there is a link to: https://docs.minaprotocol.com/en/architecture/lifecycle-payment-technical#fee-excess

which seems to go nowhere.

From an UX perspective I think the unsolicited language switch from English to browser-based lang when being redirected to the docs subdomain should be removed. Redirecting to a 404 is bad UX, but even if the page existed, the user never asked for a language change

As pointed out by community member sebastiansgz requesting fix

I was trying to install the mina app on my ledger 
I'm using windows and this link doesn't work

Currently if you follow the step-by-step message board tutorial, it omits discussion of deployment and implementing a deploy function, which is a pretty critical part of the development cycle.

At mobile viewport sizes, body text and links have inconsistent sizes, 1rem vs 1.125rem.

Update Integrating a Smart Contract in a UI Docs with a Local Development section that includes using npm link. Add a Setup section.