Skip to content

docs(mode-1172,mode-1182): update miner docs #40

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
Merged
parkhomenko merged 11 commits into from
Jan 13, 2025
Merged

docs(mode-1172,mode-1182): update miner docs #40

parkhomenko merged 11 commits into from
Jan 13, 2025

Conversation

@kieranroneill
Copy link
Contributor

@kieranroneill kieranroneill commented Jan 8, 2025 •
edited
Loading

Description

  • Updates the README.md to include lessons learnt during setup.
  • Re-formats the README.md to add structure and basic navigation.
  • Adds clearer instructions on setting up a miner.
  • Separate miner and validator docs to separate markdown files in the docs/ directory.

@kieranroneill kieranroneill added the documentation Improvements or additions to documentation label Jan 8, 2025
@kieranroneill kieranroneill self-assigned this Jan 8, 2025
Thykof
Thykof previously approved these changes Jan 8, 2025
View reviewed changes
Thykof
Thykof reviewed Jan 10, 2025
View reviewed changes
Thykof
Thykof reviewed Jan 11, 2025
View reviewed changes
@kieranroneill kieranroneill changed the title docs: update miner docs docs(mode-1172,mode-1182): update miner docs Jan 13, 2025
Thykof
Thykof reviewed Jan 13, 2025
View reviewed changes
Copy link
Member

@Thykof Thykof left a comment

Choose a reason for hiding this comment

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

cool!

@parkhomenko parkhomenko merged commit cec45e5 into main Jan 13, 2025
1 check passed
@parkhomenko parkhomenko deleted the docs/update-miner-docs branch January 13, 2025 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Thykof Thykof Thykof approved these changes

@parkhomenko parkhomenko Awaiting requested review from parkhomenko

Assignees

@kieranroneill kieranroneill

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kieranroneill @Thykof @parkhomenko