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 typos fix and grammar suggestions #68

Merged
merged 1 commit into from
Apr 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/user-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide is meant to cover all operational aspects of the recovery tool, inclu
2. Recovering the private key material from a recovery package
3. Generating a self-serve recovery package

This guide does not cover technical aspects such as the source code, classes, architecture of flow within the software.
This guide does not cover technical aspects such as the source code, classes or architecture of flow within the software.

## <u>Table of Contents</u>

Expand All @@ -29,9 +29,9 @@ Some of the major downsides of the original tool were:
- The offline machine had to be online initially to setup the tool
- Creating an `EdDSA` transaction would be cumbersome for non-technical users, requiring actual code writing and operation of the tool

These downsides would result in the operational time from getting a recovery package to gaining confidence in the tool's and user's ability to recover the keys to be rather long and the entire process drawn out with back-and-forth discussions with Fireblocks support or operation teams.
These downsides would result in the operational time from getting a recovery package to gaining confidence in the tool's and user's ability to recover the keys being rather long, and the entire process being drawn out with back-and-forth discussions with Fireblocks support or operation teams.

The new tool resolves these downsides by providing a simple and streamlined approach to recovering or verifying keys with minimal coding and setup required.
The new tool resolves these downsides by providing a simple and streamlined approach to recovering or verifying keys, with minimal coding and setup required.

### <u>Usages</u>

Expand All @@ -43,7 +43,7 @@ The tool features three modes of operation, depending on your specific need:

#### <u>Generating a Recovery Package</u>

Self-serve backup can be performed from the Fireblocks Console and as part of it some steps are required.
Self-serve backup can be performed from the Fireblocks Console and as part of that, some steps are required.

This mode allows you to perform those steps via the tool for a step-by-step experience with little friction with the console and a detailed explanation of each operation required.
<br>
Expand All @@ -52,14 +52,14 @@ This mode allows you to perform those steps via the tool for a step-by-step expe

Part of the recovery tool's ability is to verify the recovery package itself.

The meaning of _`verify`_ in this context is to make sure that the extended public key generated by the recovery kit matches the extended public key that is expected by the recovery package. In addition, this key can be compared to the extended public key presented in the UI (assuming still accessible) for another layer of verification.
The meaning of _`verify`_ in this context is to make sure that the extended public key generated by the recovery kit matches the extended public key that is expected by the recovery package. In addition, this key can be compared to the extended public key presented in the UI (assuming it is still accessible) for another layer of verification.

This mode can only be done on an **offline machine**.
<br>

#### <u>Recovering Private Key Material</u>

The most critical part of the reocvery package is to supply the ability to - **in case of disaster** - recover your workspace's private key material.
The most critical part of the reocvery package is to provide the ability to - **in case of disaster** - recover your workspace's private key material.

Recovering the private key is an extremely sensitive operation that will expose your private key material, which can result in a loss of funds.

Expand Down