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

[docs] Review: about-iota #5577

Open
semenov-vladyslav opened this issue Feb 24, 2025 · 0 comments
Open

[docs] Review: about-iota #5577

semenov-vladyslav opened this issue Feb 24, 2025 · 0 comments
Assignees
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation

Comments

@semenov-vladyslav
Copy link
Contributor

Doc page about-iota contains the following defects:

  • Here are the key features of Move: -- can't end a sentence at the end of a paragraph with a colon, the features listed in the subsequent subsections. Just put a period there or add that "The key features of Move are outlined below."
  • Move is based on Rust, a programming language known for its performance and safety -- weird sentence. What does it mean -- "based on Rust"? It's not a fork/subset/dialect of Rust. Maybe, "inspired by Rust"? It doesn't follow that Move will also inherit Rust's performance and safety. Maybe, "Move prioritizes safety and efficiency, with Rust’s ownership model inspiring Move's approach to memory management and resource control"?
  • It's almost impossible to make a programming mistake that the compiler won't catch -- it's not hard to make a logic error that the compiler won't catch, arithmetic overflows is another source of run-tine errors, rust has its own antipatterns. Maybe, clarify what "programming mistake" is? Warning following that paragraph clarifies things a bit, though.
  • IOTA EVM is not available on the IOTA Move Testnet. snippet -- "IOTA Move Testnet" is not defined in the doc, maybe "IOTA Testnet"?
  • in paragraph #### IOTA EVM Testnet there's a snippet <NotAvailableOnTestnet/> (IOTA EVM is not available on the IOTA Move Testnet) and the following sentence IOTA EVM Testnet is the distinct Layer 2 EVM running on top of the IOTA Testnet network which directly contradicts the snippet. Needs clarification.
  • Validators on the IOTA network must secure a certain amount of IOTA tokens on the IOTA Mainnet to demonstrate their commitment to the network's security. -- 1. No need to duplicate/mix "IOTA network"/"IOTA Mainnet". 2. Adversarial validators will also stake their tokens, but not in order to commit to the network's security. IMHO, "to demonstrate their commitment to the network's security" doesn't sound right. Maybe, "to incentivize honest behavior" (and thus making network more secure)?
  • without the high energy demands of earlier blockchains -- maybe mention that the "earlier blockchains" use Proof-of-Work that simply wastes resources.
@semenov-vladyslav semenov-vladyslav added devx Issues related to the DevX team documentation Improvements or additions to documentation labels Feb 24, 2025
@github-project-automation github-project-automation bot moved this to Product Backlog in Developer Experience Feb 24, 2025
@lucas-tortora lucas-tortora moved this from Product Backlog to Sprint Backlog in Developer Experience Feb 25, 2025
@Ginowine Ginowine moved this from Sprint Backlog to In Progress in Developer Experience Feb 26, 2025
@Ginowine Ginowine moved this from In Progress to Under Review in Developer Experience Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devx Issues related to the DevX team documentation Improvements or additions to documentation
Projects
Status: Under Review
Development

No branches or pull requests

2 participants