-
Notifications
You must be signed in to change notification settings - Fork 173
Open
Description
I've noticed the documentation is lightly broken/out of date in places:
- https://docs.minaprotocol.com/using-mina/install-a-wallet: "next" link at the bottom points to this page itself. Should probably go to the current next page in the section, which is https://docs.minaprotocol.com/using-mina/ledger-hardware-wallet as of writing.
- https://docs.minaprotocol.com/mina-protocol: says there is a network called
berkeleythat's distinct from mainnet. I'm pretty sure that network no longer exists? In fact, there will soon be a mesa testnet available. - https://docs.minaprotocol.com/node-operators: references an
izmirnetwork that I'm pretty sure also does not exist. - https://docs.minaprotocol.com/mina-protocol/sending-a-payment: says "A better tool is coming soon: Generate offline-transaction from keypairs generated via generate-keypair mina#8928". That issue is 4 years old. It may have been resolved but not closed - we should check. Otherwise, perhaps phrase this a little more honestly.
- https://docs.minaprotocol.com/node-operators/requirements: has a
cautionblock related to release 3.1.0. Might want to be release 3.1.0 or later. - https://docs.minaprotocol.com/node-operators/block-producer-node/getting-started: uses release 3.0.3 as an example in the installation instructions: update this?
- https://docs.minaprotocol.com/node-operators/block-producer-node/connecting-to-the-network#stop-the-standlone-node: recommends using
ctrl-cto stop the standalone daemon, but I'm pretty sure this will not work because of this outstanding issue: Mina daemon hangs during Graphviz generation at shutdown mina#17501. Might want to recommendmina client stopinstead? Also we should get around to fixing that issue. - https://docs.minaprotocol.com/node-operators/snark-workers/getting-started: says that
daemon.jsoncan be used as a substitute for command line options, but this is actually wrong! If you try setting any of those options indaemon.jsonthen the daemon will refuse to start because it doesn't recognize them. It might be worth double-checking the runtime config code and elsewhere in the daemon just to be sure that there's no hidden way of setting any of these options in ajsonconfig file. Currently thedaemon.jsonis exclusively protocol constants, aside from thepeer_list_urloption (and providing that option in thedaemon.jsonis explicitly deprecated!). - https://docs.minaprotocol.com/node-operators/seed-peers/docker-compose: links to the https://github.com/MinaFoundation/seeds repository, which is now https://github.com/o1-labs/seeds.
- https://docs.minaprotocol.com/node-operators/data-and-history/rosetta: example code not put into code blocks. Also the link to the rosetta API is given as https://docs.cdp.coinbase.com/rosetta/docs/welcome,which is a 404. Rosetta has in fact been replaced by https://docs.cdp.coinbase.com/mesh/mesh-api-spec/api-reference, which I believe is a superset of Rosetta.
- https://docs.minaprotocol.com/node-operators/delegation-program: might need attention given Mina Foundation changes?
- https://docs.minaprotocol.com/node-operators/staking-and-snarking: again, I think the
daemon.jsonconfig stuff is outdated - those parameters cannot be given in thedaemon.jsonat all - https://docs.minaprotocol.com/node-operators/staking-service-guidelines: gives recommendation based on 3min slot time (will need updating).
- https://docs.minaprotocol.com/node-operators/troubleshooting#can-i-run-on-a-raspberry-pi--arm-based-device: I think we support ARM now? At least more than not at all?
Metadata
Metadata
Assignees
Labels
No labels