Skip to content

chore: document MinerConfig parameters #6019

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

chore: document MinerConfig parameters #6019

wants to merge 3 commits into from

Conversation

Jiloc
Copy link
Contributor

@Jiloc Jiloc commented Apr 16, 2025

Description

Add documentation for all MinerConfig parameters

Applicable issues

Additional info (benefits, drawbacks, caveats)

Checklist

  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo
  • New integration test(s) added to bitcoin-tests.yml

@Jiloc Jiloc requested a review from a team as a code owner April 16, 2025 16:59
@Jiloc Jiloc requested review from obycode and wileyj April 16, 2025 17:00
@Jiloc Jiloc self-assigned this Apr 16, 2025
@Jiloc Jiloc moved this to Status: In Review in Stacks Core Eng Apr 16, 2025
wileyj
wileyj reviewed Apr 16, 2025
View reviewed changes
wileyj
wileyj reviewed Apr 16, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wileyj wileyj wileyj left review comments

@obycode obycode Awaiting requested review from obycode

At least 2 approving reviews are required to merge this pull request.

Assignees

@Jiloc Jiloc

Labels
None yet
Projects
Stacks Core Eng
Status: Status: In Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Jiloc @wileyj