Skip to content

Commit 480149f

Browse files
xrissoulaaryanjassal
authored andcommitted
docs: update documentation changes
docs: updated source control docs: fixed formatting docs: removed irrelevant files fix: build
1 parent 85cc359 commit 480149f

25 files changed

+61
-2465
lines changed

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,13 @@ tickets in the
4949

5050
Start your journey with Polykey by following the tutorials below in sequence:
5151

52-
:::tip For a visual walkthrough, check out our
52+
:::tip Tip
53+
54+
For a visual walkthrough, check out our
5355
[getting started demo video](https://vimeo.com/884649667) after installing
54-
Polykey. :::
56+
Polykey.
57+
58+
:::
5559

5660
1. **[Installation](/docs/tutorials/polykey-cli/installation)** - Install
5761
Polykey CLI on your platform.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ specify a node path, so it automatically targets the default node path.
7070
**Shell B (for your new node, nodeB):**
7171

7272
```bash
73-
polykey agent super_start --node-path ./nodeB --background
73+
polykey agent start --node-path ./nodeB --background
7474
```
7575

7676
This command starts a new Polykey agent for nodeB in the background. The first

docs/Getting-Started/polykey-cli/managing-secrets.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,15 +111,13 @@ we created in the previous example.
111111
API_ACCESS_KEY
112112
```
113113

114-
:::note
115-
116-
### Secure Deletion of Local Secrets
114+
:::note Secure Deletion of Local Secrets
117115

118116
After adding a secret to a vault, securely delete the local copy if it's no
119117
longer needed. This ensures that no unsecured traces of sensitive information
120118
remain on your local filesystem. :::
121119

122-
## Retreiving Secrets
120+
Retreiving Secrets
123121

124122
Retrieve a secret from the given vault using the polykey secrets get command.
125123
This command accesses the encrypted content within a vault and outputs it,
@@ -225,13 +223,14 @@ vault.
225223
polykey secrets mkdir <vaultName>:<directoryPath>
226224
```
227225

228-
#### Example: Creating a Directory in a Vault
226+
:::note Example: Creating a Directory in a Vault
229227

230228
To create a directory named "NFTs" within the "my-image-vault":
231229

232230
```bash
233231
polykey secrets mkdir my-image-vault:NFTs
234232
```
233+
:::note
235234

236235
### Adding a Secret to a Directory in a Vault
237236

@@ -306,14 +305,14 @@ To view metadata about a secret:
306305
polykey secrets stat <vaultName>:<secretName>
307306
```
308307

309-
#### Example: Viewing Metadata for a Secret
308+
:::note Note
309+
310+
Example: Viewing Metadata for a Secret
310311

311312
```bash
312313
polykey secrets stat my-image-vault:NFTs/Dali.png
313314
```
314315

315-
#### Example Output
316-
317316
```bash
318317
-> polykey nodes connections
319318
host hostname nodeIdEncoded port timeout usageCount authenticated
@@ -350,14 +349,18 @@ To remove a secret from a vault:
350349
polykey secrets rm <vaultName>:<secretName>
351350
```
352351

353-
#### Example: Deleting a Secret
352+
:::note Note
353+
Example: Deleting a Secret
354354

355355
$ polykey secrets ls my-image-vault:nfts
356356
nfts/dali.png
357357
nfts/some-image.png
358358

359359
$ polykey secrets rm my-image-vault:nfts/some-image.png
360-
# note the lack of output
360+
361+
Note the lack of output
362+
363+
:::note
361364

362365
$ polykey secrets ls my-image-vault:nfts
363366
nfts/dali.png

docs/Getting-Started/polykey-cli/managing-vaults.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ If you need to remove a vault, you can delete it using the delete command:
5555
polykey vaults delete <vaultName>
5656
```
5757

58-
#### Example
58+
:::note Example
5959

6060
Delete the vault named myvault:
6161

@@ -66,6 +66,7 @@ polykey vaults rm myvault
6666
This operation does not produce output on successful execution, indicating the
6767
vault has been removed.
6868

69+
:::note
6970
## Viewing Vault History
7071

7172
Each vault maintains a version history which tracks changes over time. Use the

docs/Getting-Started/polykey-cli/sharing-vaults.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,16 @@ polykey vaults scan <nodeId>
7373

7474
- `<nodeId>`: The Node ID of the node that shared the vault with you.
7575

76-
#### Example
76+
:::note Example
7777

7878
```bash
7979
polykey vaults scan v4c11qv5fpq2fm3ropmma2sglfc9349jspqb1iutl3f7en1ckv500
8080
```
8181

8282
This command lists the vaults shared by the specified node.
8383

84+
:::note
85+
8486
## Cloning the Shared Vault
8587

8688
After identifying the shared vaults, the recipient can clone the desired vault
@@ -93,12 +95,14 @@ polykey vaults clone <vaultName> <nodeId>
9395
- `<vaultName>`: The name of the vault to be cloned.
9496
- `<nodeId>`: The Node ID from which to clone the vault.
9597

96-
### Example
98+
:::note Example
9799

98100
```bash
99101
polykey vaults clone myvault v4c11qv5fpq2fm3ropmma2sglfc9349jspqb1iutl3f7en1ckv500
100102
```
101103

104+
:::note
105+
102106
This command clones "myvault" from the specified node to the local system.
103107

104108
## Synchronizing Changes
@@ -114,14 +118,16 @@ polykey vaults pull <vaultName> <targetNodeId>
114118
- `<vaultNameOrId>`: The name or ID of the vault to update.
115119
- `<targetNodeId>`: (Optional) The node ID from which to pull updates.
116120

117-
### Example
121+
:::note Example
118122

119123
```bash
120124
polykey vaults pull myvault v4c11qv5fpq2fm3ropmma2sglfc9349jspqb1iutl3f7en1ckv500
121125
```
122126

123127
This command updates "myvault" with the latest changes from the specified node.
124128

129+
:::note
130+
125131
## Conclusion
126132

127133
Sharing and synchronizing vaults in Polykey enhances collaboration and security

docs/Getting-Started/polykey-cli/using-environment-variables.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ management of environment variables. It allows for the dynamic and secure
132132
handling of sensitive data across different stages of development and
133133
deployment.
134134

135-
## Additional References
135+
:::note Additional References
136136

137137
We encourage you to delve deeper into Polykey and consider integrating it into
138138
your workflows. For further insights and to participate in community
@@ -144,6 +144,8 @@ discussions, please explore the following resources:
144144
- [Using Polykey for secure access to cloud providers:](https://polykey.com/blog/introducing-a-new-standard-in-environment-secrets-management-with-polykey)
145145
Learn how Polykey facilitates secure interactions with cloud services.
146146

147+
:::note
148+
147149
## Tying It All Together
148150

149151
**1. Initial Setup by User A:**

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

Lines changed: 0 additions & 5 deletions
This file was deleted.

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

Lines changed: 0 additions & 118 deletions
This file was deleted.

docs/reference/polykey-cli/commands/secrets.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,11 @@ $ polykey secrets dir ~/test-dir vault1
6565
3. If the edited file isn't saved or the editor crashes, the secret will not be
6666
written
6767

68-
:::warning This command does not work on Windows yet :::
68+
:::warning Warning
69+
70+
This command does not work on Windows yet
71+
72+
:::
6973

7074
Usage:
7175

@@ -85,7 +89,11 @@ I edited this secret inside an editor
8589
4. If no paths are specified, this command takes input from `stdin` and prints
8690
it to `stdout`
8791

88-
:::tip `^D` in the terminal stands for the key combination 'Ctrl-D' :::
92+
:::tip Tip
93+
94+
`^D` in the terminal stands for the key combination 'Ctrl-D'
95+
96+
:::
8997

9098
Usage:
9199

@@ -184,7 +192,11 @@ new-name
184192
1. Get the stats of a specified secret from a vault
185193
2. Requires secret location (vaultName:secretName) as a parameter
186194

187-
:::note The mode (or file permissions) doesn't exist within a vault :::
195+
:::note Note
196+
197+
The mode (or file permissions) doesn't exist within a vault
198+
199+
:::
188200

189201
Usage:
190202

@@ -213,7 +225,10 @@ blocks: 1
213225
2. Run a command with the specified variables, or export them in the current
214226
working environment
215227

216-
:::note Separate the environment variables from the command by passing in a `--`
228+
:::note Note
229+
230+
Separate the environment variables from the command by passing in a `--`
231+
217232
:::
218233

219234
Usage:
@@ -253,11 +268,15 @@ do not commit your keys to github
253268
1. Reads input from `stdin` and writes it to the specified file
254269
2. If the file doesn't exist, it gets created
255270

256-
:::tip `stdin`, or standard input, can be either manually entered by typing, or
271+
:::tip Tip
272+
273+
`stdin`, or standard input, can be either manually entered by typing, or
257274
piped in through another command.
258275

259276
To close the input steam and save the file, press `^D`, or 'Ctrl-D' in a new
260-
line, or press `^D` twice on the same line. :::
277+
line, or press `^D` twice on the same line.
278+
279+
:::
261280

262281
Usage:
263282

docs/tutorials/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)