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: enhance readability of page #30

Merged
merged 6 commits into from
Jun 15, 2022

Conversation

emnul
Copy link
Contributor

@emnul emnul commented May 13, 2022

Description of the Changes

The transaction lifecycle page needed some readability improvements in a couple places

Check List

  • Changes have been done against dev branch, and PR does not conflict
  • Docs have been updated
  • PR title is follow the convention: <docs/feat/fix/chore>(optional scope): <description>, e.g: fix: minor typos in code

This change is Reviewable

@ArielElp ArielElp self-requested a review May 19, 2022 21:32
Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 1 files reviewed, all discussions resolved

Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @ArielElp and @emanuel-sol)


docs/Blocks/transaction-life-cycle.md line 3 at r1 (raw file):

# Transaction Lifecycle

The following are the possible statuses of a transaction from the moment it's included in a proof to the moment it's validated by L1.

Thanks, that was bad!


docs/Blocks/transaction-life-cycle.md line 38 at r1 (raw file):

## The pending block

Today, StarkNet supports querying the new block before its construction is complete. This feature improves the uptime of the system prior to the decentralization phase, but will probably become obsolete once the system is decentralized, as full nodes will only propagate finalized blocks through the network.

I don't like uptime here, maybe responsiveness, because the system is still up and creating the block even if the apis don't report it.

@emnul
Copy link
Contributor Author

emnul commented May 20, 2022

I don't like uptime here, maybe responsiveness, because the system is still up and creating the block even if the apis don't report it.

@ArielElp I agree, responsiveness makes more sense.

Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @emanuel-sol)

Copy link
Collaborator

@ArielElp ArielElp left a comment

Choose a reason for hiding this comment

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

Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @emanuel-sol)

@ArielElp ArielElp merged commit 0447f83 into starknet-io:dev Jun 15, 2022
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.

3 participants