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: Refactor the installation instructions for s-nomp #7835

Merged
merged 5 commits into from
Oct 26, 2023

Conversation

upbqdn
Copy link
Member

@upbqdn upbqdn commented Oct 25, 2023

Motivation

When working on #7423, I noticed our documentation for mining with s-nomp was outdated.

Solution

  • Don't mention the getblocktemplate-rpcs feature anymore.
  • Refactor the installation instructions for s-nomp. I only did this refactor for the Arch Linux section.

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?

@upbqdn upbqdn added A-docs Area: Documentation P-Low ❄️ labels Oct 25, 2023
@upbqdn upbqdn self-assigned this Oct 25, 2023
@upbqdn upbqdn requested a review from a team as a code owner October 25, 2023 23:29
@upbqdn upbqdn requested review from teor2345 and removed request for a team October 25, 2023 23:29
@upbqdn
Copy link
Member Author

upbqdn commented Oct 25, 2023

Note that I refactored the install instructions only for the Arch Linux section.

@upbqdn
Copy link
Member Author

upbqdn commented Oct 25, 2023

Note that I refactored the install instructions only for the Arch Linux section.

Also, the general instructions don't work anymore as they miss some necessary steps, such as using Python 3.10. I updated only the Arch section since I tested the new instructions only on that distribution. I thought this is acceptable since we don't plan to rely on s-nomp substantially.

Copy link
Collaborator

@teor2345 teor2345 left a comment

Choose a reason for hiding this comment

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

I think that's fine for now

mergify bot added a commit that referenced this pull request Oct 26, 2023
@mergify mergify bot merged commit 06ab529 into main Oct 26, 2023
68 checks passed
@mergify mergify bot deleted the refactor-s-nomp-instructions branch October 26, 2023 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants