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

migrate info on pow-mining from ethdocs and eth.wiki #5897

Merged
merged 18 commits into from
May 10, 2022
Merged

migrate info on pow-mining from ethdocs and eth.wiki #5897

merged 18 commits into from
May 10, 2022

Conversation

jmcook1186
Copy link
Contributor

Description

This PR aims to migrate information from the ethdocs.org and eth.wiki sites to appropriate pages on ethereum.org so that the information is preserved when those websites are deprecated.

To this end, I have done the following:

  1. Added some introductory material to the existing pow mining page
  2. Added a brief high-level paragraph on mining algorithms to the existing pow-mining page
  3. Added a new directory, /mining-algorithms, beneath /consensus-mechanisms/pow
  4. Added a landing page and two subdirectories to /mining-algorithms: /dagger-hashamoto and ethash
  5. Migrate info from ethdocs and eth.wiki pages on mining algorithms into dagger-hashamoto/index.md and ethhash/index.md
  6. Update menus and links to make new pages visible.

Related Issue

This resolves suggested PR 12 from #5690 and PR 3 from #5731

@github-actions github-actions bot added content 🖋️ This involves copy additions or edits review needed 👀 labels Apr 4, 2022
@gatsby-cloud
Copy link

gatsby-cloud bot commented Apr 4, 2022

Gatsby Cloud Build Report

ethereum-org-website-dev

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 15m

Performance

Lighthouse report

Metric Score
Performance 🔶 26
Accessibility 💚 100
Best Practices 💚 100
SEO 💚 92

🔗 View full report

@jmcook1186 jmcook1186 marked this pull request as ready for review April 5, 2022 10:25
Copy link
Contributor

@minimalsm minimalsm left a comment

Choose a reason for hiding this comment

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

Looking great! Found it very well put together and educational for me.

Comments are mostly around site conventions or some simplifications I think we could make, but I'll leave those up to you.

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

@jmcook1186 🙏🏻 Thank you again for these. Great addition to fill out the background of PoW, appreciate your work on this. This seems super close.. bunch of code suggestions left, mostly non-controversial I feel.

Let me know if you want a hand tuning this up, we'll try to get this in soon =)

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

💪🏻 Thanks again @jmcook1186!

Copy link
Contributor

@minimalsm minimalsm left a comment

Choose a reason for hiding this comment

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

LGTM :) Pushed some commits to add further reading section to each page. Merging now 🚀

Some low priority things we should tidy up at some point:

  • Memory hard - should we explain what this means? (I’ve added a link out to wikipedia for now)
  • Appendix - We should link to appendix using footnotes (see NFT page for example of this on site)
  • EthHash page needs prerequisites
  • UI bug introduced in our developer docs sidenav by the depth (I will create an issue)

Dagger Hashamoto page

“## More efficient cache-based evaluation algorithm {#cache-based-evaluation}” section

  • Providing a sentence for context here would be good

@minimalsm minimalsm merged commit 0d87e8f into ethereum:dev May 10, 2022
@minimalsm minimalsm mentioned this pull request May 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants