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

CDK Erigon - update overview #1583

Merged
merged 2 commits into from
Oct 3, 2024
Merged

CDK Erigon - update overview #1583

merged 2 commits into from
Oct 3, 2024

Conversation

EmpieichO
Copy link
Collaborator

@EmpieichO EmpieichO commented Oct 3, 2024

CDK Erigon - update overview ... as per issue https://polygon.atlassian.net/browse/DOCS-371


## CDK Erigon vs. Erigon
## CDK Erigon vs. standard Erigon
Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm just wondering if this section is a bit too high level intro to be at the bottom of the page

Copy link
Collaborator

Choose a reason for hiding this comment

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

seems like you could remove it or reword it and put it further up ... make it a table for easy reading maybe

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The issue with the section (which is what's currently published) is sounds more like marketing than actual facts.
So the idea for this review was to present the facts first, and then help the reader anticipate how these "marketing-like" statements could be true/achievable.

Copy link
Collaborator

Choose a reason for hiding this comment

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

normally you start high level then go deeper, just like headings H1 H2 H3, etc ... the reader will never reach this point probably, and if they do it will read incongruously to them ... my view is a table of differences is much more accessible for the reader and probably should go up top with links to the sections where you elaborate more fully to give the reader the option, and easy navigation to sections they might be interested in ... but that's just my view ...

Copy link

sonarcloud bot commented Oct 3, 2024

@EmpieichO EmpieichO merged commit cc4ce87 into main Oct 3, 2024
2 checks passed
@EmpieichO EmpieichO deleted the cdk-erigon-move-zkEVM branch October 3, 2024 16:04
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