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

Hash/Key Type Documentation Revamp #1449

Merged

Conversation

ACStone-MTS
Copy link
Contributor

What does this PR fix/introduce?

The Hash Types document grew beyond the original formatting as more key types were added. This PR restructures the document and updates it to include new 2.0 types.

Checklist

(Delete any that aren't relevant)

  • Docs are successfully building - yarn install && yarn run build.
  • For new internal links I used relative file paths (with .md extension) - e.g. ../../faq/faq-general.md - instead of introducing absolute file path, or relative/absolute URL.
  • All external links have been verified with yarn run check:externals.
  • My changes follow the Casper docs style guidelines.
  • If structural changes are introduced (not just content changes), cross-broswer testing has been completed.

Reviewers

@ipopescu

@ACStone-MTS ACStone-MTS added the v2.0 Merge to feat-2.0_docs label May 9, 2024
@ACStone-MTS ACStone-MTS requested a review from ipopescu May 9, 2024 15:10
@ACStone-MTS ACStone-MTS self-assigned this May 9, 2024
@ACStone-MTS
Copy link
Contributor Author

I'm assuming this will break some other page links and will update accordingly.

Copy link
Collaborator

@ipopescu ipopescu left a comment

Choose a reason for hiding this comment

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

I have questions on this PR, because some of these hashes don't match the output I see in testing. Let's get a tech reviewer or connect on Monday with someone to double-check these and see what I might be misunderstanding.

The file I checked against is casper-node/types/src/key.rs. I also used the output I shared this week from installing the counter contract on a 2.0 NCTL network.

source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Outdated Show resolved Hide resolved
source/docs/casper/concepts/key-types.md Show resolved Hide resolved
ACStone-MTS and others added 6 commits May 10, 2024 10:45
@ipopescu ipopescu self-requested a review May 14, 2024 16:03
Copy link
Collaborator

@ipopescu ipopescu left a comment

Choose a reason for hiding this comment

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

LGTM!

@ACStone-MTS ACStone-MTS merged commit 40e9e5f into casper-network:feat-2.0_docs May 24, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v2.0 Merge to feat-2.0_docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants