Merge pull request #162 from yash251/cleanup

fix: typos
NillionNetwork · Jan 6, 2025 · 50865f8 · 50865f8
2 parents 5790be9 + 03be8ca
commit 50865f8
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 13 deletions.
diff --git a/docs/data-wars.md b/docs/data-wars.md
@@ -50,7 +50,7 @@ The rule applies for memes and art as well. We cherish originality. Craft your u
 
 Don’t create based on what you assume we want to see - create what resonates with you.
 
-If you are a photographer then take photos, if you’re a musician then create music, if you’re a writer then create lore. If you don’t currently do anything then learn something new. Spend some time with the rest of the community to learn a new skill and use Nilions ideas, visions, and beliefs as cues to create something amazing and impactful.
+If you are a photographer then take photos, if you’re a musician then create music, if you’re a writer then create lore. If you don’t currently do anything then learn something new. Spend some time with the rest of the community to learn a new skill and use Nillion's ideas, visions, and beliefs as cues to create something amazing and impactful.
 
 #### Scribe Classes
 

diff --git a/docs/js-client-hooks-other.md b/docs/js-client-hooks-other.md
@@ -1,8 +1,9 @@
 # Other
 
 There are some auxiliary hooks that you may use:
-- [useNilPoolStatus](#usenilpoolstatus)
-- [useNillion](#usenillion)
+- [Other](#other)
+    - [useNilPoolStatus](#usenilpoolstatus)
+    - [useNillion](#usenillion)
 
 ### useNilPoolStatus
 Pool Status refers to the preprocessing pool's status. A simple call to the hook should provide their status.
@@ -25,7 +26,7 @@ nillion.client.XXX // whatever you want to use from the client.
 
 ```
 
-Below is the source code for refernce
+Below is the source code for reference
 
 ```tsx reference showGithubLink
 https://github.com/NillionNetwork/client-ts/blob/main/client-react-hooks/src/use-nillion.ts

diff --git a/docs/js-client-hooks-values.md b/docs/js-client-hooks-values.md
@@ -1,9 +1,10 @@
 # Values
 
-Storage and retreival of values are available via:
-- [useNilStoreValues](#usenilstorevalues)
-- [useNilRetrieveValues](#usenilretrievevalues)
-- [useNilDeleteValues](#usenildeletevalues)
+Storage and retrieval of values are available via:
+- [Values](#values)
+    - [useNilStoreValues](#usenilstorevalues)
+    - [useNilRetrieveValues](#usenilretrievevalues)
+    - [useNilDeleteValues](#usenildeletevalues)
 
 ### useNilStoreValues
 
@@ -16,7 +17,7 @@ https://github.com/NillionNetwork/client-ts/blob/main/examples-nextjs/app/compon
 ```
 
 ### useNilRetrieveValues
-Retreiving only requires one argument: `id` . This `id` comes from a previous stored value (i.e after you call `useNilStoreValues`).
+Retrieving only requires one argument: `id` . This `id` comes from a previous stored value (i.e after you call `useNilStoreValues`).
 
 ``` tsx
 // i.e. 31d8ab8d-dced-494b-99cc-bd34f1d80b26

diff --git a/docs/js-client-hooks.md b/docs/js-client-hooks.md
@@ -4,9 +4,9 @@ import DocCardList from '@theme/DocCardList';
 Hooks are functions that help you easily read/write into Nillion network and interact with Nada Programs. Our [examples/nextjs](https://github.com/NillionNetwork/client-ts/tree/main/examples-nextjs) have all of these as components to better understand how to interact with them.
 
 To best understand how Nillion functions, it provides two main focuses:
-1. Storage of [values](./js-client-hooks-values.md) and retreiving them
+1. Storage of [values](./js-client-hooks-values.md) and retrieving them
 2. Blind [computation](./js-client-hooks-compute.md) powered by MPC with Nada Programs. 
 
-[Permissions](./js-client-hooks-permissions.md) are added ontop of the network to allow/restrict who can interact with the storage and compute. 
+[Permissions](./js-client-hooks-permissions.md) are added on top of the network to allow/restrict who can interact with the storage and compute. 
 
 <DocCardList/>
diff --git a/docs/js-quickstart.md b/docs/js-quickstart.md
@@ -183,7 +183,7 @@ Copy the up the .env.example file to a new .env and set up these variables to ma
 cp .env.example .env
 ```
 
-Update your newly created .env with environment variables outout in your terminal by nillion-devnet
+Update your newly created .env with environment variables output in your terminal by nillion-devnet
 
 ```
 REACT_APP_NILLION_CLUSTER_ID=

diff --git a/docs/quickstart-install.md b/docs/quickstart-install.md
@@ -9,7 +9,7 @@ Install the Nillion SDK in one command. This includes the <strong>`nada`</strong
 :::info
 Nillion SDK binaries are available for [Linux and macOS platforms](/limitations#platforms). For Windows installation, make sure to follow our [Windows developer environment setup](/installation#windows-guide) guide ahead of installing binaries.
 
-Prerequisties:
+Prerequisites:
 
 - Python (>= 3.10)
 - Node (>= v18.17)