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

Add instructions for mining with s-nomp to Zebra book #6220

Merged
merged 3 commits into from
Feb 27, 2023
Merged

Conversation

mpguerra
Copy link
Contributor

Motivation

Detailed mining instructions point back to this zebra github repo instead of the Zebra book even though they are within the book directory.

Solution

Add the file to the contents on SUMMARY.md and link to its location in the book.

Review

Do we actually want to show this in the book or was it fine the way it was?

Reviewer Checklist

  • Will the PR name make sense to users?
    • Does it need extra CHANGELOG info? (new features, breaking changes, large changes)
  • Are the PR labels correct?
  • Does the code do what the ticket and PR says?
    • Does it change concurrent code, unsafe code, or consensus rules?
  • How do you know it works? Does it have tests?

Follow Up Work

@mpguerra mpguerra requested a review from a team as a code owner February 24, 2023 12:01
@mpguerra mpguerra requested review from oxarbitrage and removed request for a team February 24, 2023 12:01
@github-actions github-actions bot added the C-feature Category: New features label Feb 24, 2023
@mpguerra mpguerra added P-Optional ✨ A-docs Area: Documentation C-cleanup Category: This is a cleanup labels Feb 24, 2023
arya2
arya2 previously approved these changes Feb 24, 2023
Copy link
Contributor

@arya2 arya2 left a comment

Choose a reason for hiding this comment

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

Looks good!

book/src/SUMMARY.md Outdated Show resolved Hide resolved
@teor2345
Copy link
Contributor

Do we actually want to show this in the book or was it fine the way it was?

I don't mind either way. s-nomp is not suitable for production mining, so we could leave it out of the index. But that also makes our docs less usable and hard to find.

mpguerra and others added 2 commits February 27, 2023 10:25
nest under mining

Co-authored-by: Arya <aryasolhi@gmail.com>
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

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

Looks good, i made a suggestion to be more clear that the s-nomp guide is not production but feel free to ignore it.

mergify bot added a commit that referenced this pull request Feb 27, 2023
@mergify mergify bot merged commit 45cbc14 into main Feb 27, 2023
@mergify mergify bot deleted the pili-mining-book branch February 27, 2023 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-cleanup Category: This is a cleanup C-feature Category: New features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants