Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

docs: add bootstrapper command docs #477

Merged
merged 1 commit into from
Sep 19, 2023

Conversation

rach-id
Copy link
Member

@rach-id rach-id commented Sep 18, 2023

Overview

Closes #344

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@rach-id rach-id added documentation Improvements or additions to documentation p2p p2p network related labels Sep 18, 2023
@rach-id rach-id self-assigned this Sep 18, 2023
@rach-id rach-id enabled auto-merge (squash) September 18, 2023 18:39
@codecov-commenter
Copy link

Codecov Report

Merging #477 (29f5baa) into main (3306189) will not change coverage.
Report is 1 commits behind head on main.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #477   +/-   ##
=======================================
  Coverage   25.37%   25.37%           
=======================================
  Files          29       29           
  Lines        2834     2834           
=======================================
  Hits          719      719           
  Misses       2029     2029           
  Partials       86       86           

Comment on lines +27 to +29
In order for the bootstrapper to start, it will need a P2P private key in store.

The P2P private key is optional, and a new one will be generated automatically on the start if none is provided.
Copy link
Member

Choose a reason for hiding this comment

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

these sentences are a bit confusing

it needs...
... is optional

perhaps we can just drop the first sentence

Copy link
Member

Choose a reason for hiding this comment

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

cc @sweexordious since it auto merged

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation p2p p2p network related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document the qgb bootstrapper command
3 participants