Skip to content

Commit d07f2ee

Browse files
committed
docs: updated managing secrets page
fix: lint fix: spelling
1 parent 480149f commit d07f2ee

File tree

11 files changed

+183
-147
lines changed

11 files changed

+183
-147
lines changed

docs/Getting-Started/polykey-cli/README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,10 @@ Polykey is continuously built and tested on:
3737

3838
:::note Note
3939

40-
Polykey is currently in beta. Its interface is at various levels of
41-
stability. So bear with us as we perfect its design. You can contribute by
42-
discussing with us on [Discord](https://discord.gg/h3UShM8WUN) or creating issue
43-
tickets in the
44-
[Polykey-CLI repo on GitHub](https://github.com/MatrixAI/Polykey-CLI).
40+
Polykey is currently in beta. Its interface is at various levels of stability.
41+
So bear with us as we perfect its design. You can contribute by discussing with
42+
us on [Discord](https://discord.gg/h3UShM8WUN) or creating issue tickets in the
43+
[Polykey-CLI repo on GitHub](https://github.com/MatrixAI/Polykey-CLI).
4544

4645
:::
4746

@@ -53,7 +52,7 @@ Start your journey with Polykey by following the tutorials below in sequence:
5352

5453
For a visual walkthrough, check out our
5554
[getting started demo video](https://vimeo.com/884649667) after installing
56-
Polykey.
55+
Polykey.
5756

5857
:::
5958

docs/Getting-Started/polykey-cli/bootstrapping.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,16 @@ key.
2626

2727
:::note Note
2828

29-
Remember to keep your password in a secure location as you will need it each time you start the Polykey agent.
29+
Remember to keep your password in a secure location as you will need it each
30+
time you start the Polykey agent.
3031

3132
:::
3233

3334
:::important
3435

35-
Bootstrapping also returns a **recovery code**. This code is required to recover a node with the same ID, so it is critical that you store it safely and securely. If lost, node identity recovery will not be possible.
36+
Bootstrapping also returns a **recovery code**. This code is required to recover
37+
a node with the same ID, so it is critical that you store it safely and
38+
securely. If lost, node identity recovery will not be possible.
3639

3740
:::
3841

docs/Getting-Started/polykey-cli/claiming-digital-identities.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Establishing Identity Linkages in Polykey
1+
# Establishing Identity Linkages
22

33
In Polykey, claiming a digital identity is a crucial step that allows users to
44
establish their identity across various platforms and link these identities to
@@ -8,7 +8,9 @@ cryptographic link to a publicly verifiable location.
88

99
This tutorial will guide you through the steps to authenticate with GitHub and
1010
claim an identity using Polykey, enhancing security and streamlining identity
11-
verification, making it easier for other users to discover and trust your nodes. Currently, we only support github as an identity provider, but we plan to add more in the future.
11+
verification, making it easier for other users to discover and trust your nodes.
12+
Currently, we only support github as an identity provider, but we plan to add
13+
more in the future.
1214

1315
## Step 1: Authenticate with GitHub
1416

@@ -33,8 +35,8 @@ polykey identities authenticate <providerId>
3335

3436
:::note Note
3537

36-
Since Polykey currently only supports GitHub as an IdP, this is the
37-
command that you will use to start the authentication process.
38+
Since Polykey currently only supports GitHub as an IdP, this is the command that
39+
you will use to start the authentication process.
3840

3941
```bash
4042
polykey identities authenticate github
@@ -74,19 +76,19 @@ identityId maverick
7476
During the authentication process, here's what Polykey requests access to and
7577
why:
7678

77-
- **Currently: Create Gists:** Polykey creates a gist under your GitHub account containing
78-
a cryptographic link. This link is a verifiable method that proves the
79-
ownership of your GitHub identity to anyone checking your Polykey gestalt
79+
- **Currently: Create Gists:** Polykey creates a gist under your GitHub account
80+
containing a cryptographic link. This link is a verifiable method that proves
81+
the ownership of your GitHub identity to anyone checking your Polykey gestalt
8082
graph.
8183

8284
-:::note Note
8385

84-
**Future Plan: Read All User Profile Data:** This enables Polykey to access your profile
85-
details, including your username, followers, and public repository data. This
86-
information is used to ensure that the identity you claim corresponds
87-
accurately to your public digital footprint, enhancing trust and verification.
86+
**Future Plan: Read All User Profile Data:** This enables Polykey to access your
87+
profile details, including your username, followers, and public repository data.
88+
This information is used to ensure that the identity you claim corresponds
89+
accurately to your public digital footprint, enhancing trust and verification.
8890

89-
:::
91+
:::
9092

9193
#### Security and Privacy Considerations
9294

@@ -150,7 +152,7 @@ https://gist.github.com/my-github-username
150152

151153
This gist contains the cryptographic link confirming that your Polykey identity
152154
is correctly linked to your GitHub profile. Viewing this gist ensures your claim
153-
was successful and publicly verifiable.
155+
was successful and publicly verifiable.
154156

155157
:::note Note
156158

docs/Getting-Started/polykey-cli/discovering-other-users.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,10 @@ polykey identities discover <gestaltId>
3838
```bash
3939
polykey identities discover github.com:maverick
4040
```
41-
:::note Note
42-
This command adds the node associated with the GitHub username "maverick" to
43-
your discovery queue, allowing you to initiate interactions with this user.
41+
42+
:::note Note This command adds the node associated with the GitHub username
43+
"maverick" to your discovery queue, allowing you to initiate interactions with
44+
this user.
4445

4546
:::
4647

@@ -117,7 +118,8 @@ managed:
117118

118119
- **Scan:** Allows the node to scan for vaults
119120
- **Notify:** Allows sending notifications about changes or updates.
120-
- **Claim** Allows a different gstalt to claim the node
121+
- **Claim** Allows a different gstalt to claim the node
122+
121123
#### Example Command to Set Permissions
122124

123125
```bash
@@ -192,8 +194,8 @@ polykey identities list
192194

193195
### Trusting and Untrusting Nodes
194196

195-
You can explicitly trust or untrust individual nodes or entire gestalts to refine how notifications and
196-
access controls are handled:
197+
You can explicitly trust or untrust individual nodes or entire gestalts to
198+
refine how notifications and access controls are handled:
197199

198200
```bash
199201
polykey identities trust <gestaltId>

docs/Getting-Started/polykey-cli/installation.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,17 @@ Installing the CLI can be done in different ways depending on your operating
66
environment.
77

88
:::info
9+
910
## Polykey Core Overview
1011

11-
The Polykey CLI and core primarily use TypeScript for service logic, domain business operations, and persistence layers. While the main codebase is in TypeScript, some supporting libraries incorporate native C++ or Rust for platform‐specific functionality. This approach combines cross‐platform convenience with native performance optimizations.
12-
Polykey-CLI has only been tested on Linux and macOS. We are working on
13-
supporting other platforms. There's minor teething problems when it comes
14-
supporting other platforms. Help us by reporting any issues with the CLI tool in
15-
our Github Repo
12+
The Polykey CLI and core primarily use TypeScript for service logic, domain
13+
business operations, and persistence layers. While the main codebase is in
14+
TypeScript, some supporting libraries incorporate native C++ or Rust for
15+
platform‐specific functionality. This approach combines cross‐platform
16+
convenience with native performance optimizations. Polykey-CLI has only been
17+
tested on Linux and macOS. We are working on supporting other platforms. There's
18+
minor teething problems when it comes supporting other platforms. Help us by
19+
reporting any issues with the CLI tool in our Github Repo
1620
[here](https://github.com/MatrixAI/Polykey-CLI/issues/new/choose) or by dropping
1721
a message to the developers in our discord server
1822
[here](https://discord.gg/dC32r35TeE).
@@ -134,9 +138,9 @@ We will be working on other distribution methods.
134138

135139
:::info
136140

137-
ARM-64 builds are not currently supported on MacOS as of **6 April 2025.** However,
138-
building Polykey yourself on MacOS resolves in a working binary. Follow this
139-
guide below to manually build and install Polykey on macOS.
141+
ARM-64 builds are not currently supported on MacOS as of **6 April 2025.**
142+
However, building Polykey yourself on MacOS resolves in a working binary. Follow
143+
this guide below to manually build and install Polykey on macOS.
140144

141145
:::
142146

@@ -290,7 +294,7 @@ echo 'export PATH=~/Downloads:$PATH' >> ~/.zshrc && source ~/.zshrc
290294

291295
The path export should not pint to the Polykey executable itself, but rather to
292296
the directory containing the executable. Otherwise, the executable will not be
293-
found and will not work.
297+
found and will not work.
294298

295299
:::
296300

@@ -300,7 +304,7 @@ found and will not work.
300304
2. Edit the Bash config to add "polykey" to your path. To streamline the
301305
process, run the following command, making sure to change the path to
302306
"polykey" if the executable is not in the downloads folder. For most users,
303-
this would be `~/Downloads`
307+
this would be `~/Downloads`
304308

305309
:::tip
306310

docs/Getting-Started/polykey-cli/managing-multiple-nodes.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
Managing multiple local
44

5-
nodes in Polykey can serve various purposes. For example, you might maintain one node for personal projects and another for professional work. This segregation ensures that the vaults and their respective contents remain distinct based on their usage context.
5+
nodes in Polykey can serve various purposes. For example, you might maintain one
6+
node for personal projects and another for professional work. This segregation
7+
ensures that the vaults and their respective contents remain distinct based on
8+
their usage context.
69

710
This approach is particularly advantageous for demonstrations or training
811
purposes, as it allows you to simulate sharing vaults between two nodes on the
@@ -40,8 +43,8 @@ context.
4043

4144
:::note Note
4245

43-
If a node has not been created before, initializing the Polykey agent
44-
for it will also initiate the bootstrap process.
46+
If a node has not been created before, initializing the Polykey agent for it
47+
will also initiate the bootstrap process.
4548

4649
:::
4750

0 commit comments

Comments
 (0)