fix some grammar & punctuation

ramfox · ramfox · commit 5d323fd030e5 · 2023-08-28T18:19:58.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -15,10 +15,13 @@
 
 # production
 /build
+/public
+
 
 # misc
 .DS_Store
 *.pem
+.parcel-cache
 
 # debug
 npm-debug.log*
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/app/docs/commands/author-create/page.mdx b/src/app/docs/commands/author-create/page.mdx
@@ -14,7 +14,7 @@ export const metadata = {
 
 # author create
 
-Create a new author {{ className: 'lead' }}
+Create a new author. {{ className: 'lead' }}
 
 
 
diff --git a/src/app/docs/commands/author-list/page.mdx b/src/app/docs/commands/author-list/page.mdx
@@ -14,7 +14,7 @@ export const metadata = {
 
 # author list
 
-List authors {{ className: 'lead' }}
+List authors. {{ className: 'lead' }}
 
 
 
diff --git a/src/app/docs/commands/author-switch/page.mdx b/src/app/docs/commands/author-switch/page.mdx
@@ -21,7 +21,7 @@ Set the active author for doc insertion (only works within the console) {{ class
 
 | name | necessity | description |
 | ---- | --------- | ----------- |
-| ID  | required | id of the author to switch to |
+| ID  | required | Id of the author to switch to. |
 
 
 
diff --git a/src/app/docs/commands/blob-list-blobs/page.mdx b/src/app/docs/commands/blob-list-blobs/page.mdx
@@ -12,9 +12,9 @@ export const metadata = {
     ]} />
 </div>
 
-# blob list collections
+# blob list blobs 
 
-List the available collections on the running provider {{ className: 'lead' }}
+List the available blobs on the running provider. {{ className: 'lead' }}
 
 
 
diff --git a/src/app/docs/commands/blob-validate/page.mdx b/src/app/docs/commands/blob-validate/page.mdx
@@ -14,14 +14,14 @@ export const metadata = {
 
 # blob validate
 
-Validate hashes on the running node {{ className: 'lead' }}
+Validate hashes on the running node. {{ className: 'lead' }}
 
 
 ### Arguments
 
 | name | necessity | description |
 | ---- | --------- | ----------- |
-| repair  |  | Repair the store by removing invalid data |
+| repair  |  | Repair the store by removing invalid data. |
 
 
 
diff --git a/src/app/docs/commands/doc-get/page.mdx b/src/app/docs/commands/doc-get/page.mdx
@@ -23,10 +23,12 @@ Get entries in a document {{ className: 'lead' }}
 | ---- | --------- | ----------- |
 | KEY  | required | Key to the entry to fetch |
 | DOC_ID  | required |  Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with `doc set`. |
-| prefix  |  | If true, get all entries that start with KEY |
-| author  |  | If provided, only return entries from this author |
-| old  |  | If true, old entries will be included. By default only the latest value for each key is shown |
-| content  |  | Also print the content for each entry (but only if smaller than 1MB and valid UTf-8) |
+| prefix  |  | If true, get all entries that start with KEY. |
+| author  |  | If provided, only return entries from this author. |
+| old  |  | If true, old entries will be included. By default only the latest
+value for each key is shown. |
+| content  |  | Also print the content for each entry (but only if smaller than
+1MB and valid UTf-8). |
 
 
 
diff --git a/src/app/docs/commands/doc-join/page.mdx b/src/app/docs/commands/doc-join/page.mdx
@@ -21,7 +21,7 @@ Join a document from a ticket {{ className: 'lead' }}
 
 | name | necessity | description |
 | ---- | --------- | ----------- |
-| TICKET  | required | the ticket to join a document. Create a ticket with &#39;doc share&#39; |
+| TICKET  | required | The ticket to join a document. Create a ticket with &#39;doc share&#39;. |
 
 
 
diff --git a/src/app/docs/commands/doc-keys/page.mdx b/src/app/docs/commands/doc-keys/page.mdx
@@ -22,9 +22,9 @@ List all keys in a document {{ className: 'lead' }}
 | name | necessity | description |
 | ---- | --------- | ----------- |
 | DOC_ID  | required | Document to operate on. Required unless the document is set through the IROH_DOC environment variable. Within the Iroh console, the active document can also set with `doc set`. |
-| PREFIX  | optional | Only list keys that start with PREFIX |
-| author  | optional | Filter by author |
-| old  | optional | If true, old entries will be included. By default only the latest value for each key is shown |
+| PREFIX  | optional | Only list keys that start with PREFIX. |
+| author  | optional | Filter by author. |
+| old  | optional | If true, old entries will be included. By default only the latest value for each key is shown. |
 
 
 
diff --git a/src/app/docs/commands/doc-set/page.mdx b/src/app/docs/commands/doc-set/page.mdx
@@ -21,8 +21,8 @@ Set an entry in a document {{ className: 'lead' }}
 
 | name | necessity | description |
 | ---- | --------- | ----------- |
-| KEY  | required | Key to the entry (parsed as UTF-8 string) |
-| VALUE  | required | Content to store for this entry (parsed as UTF-8 string) |
+| KEY  | required | Key to the entry (parsed as UTF-8 string). |
+| VALUE  | required | Content to store for this entry (parsed as UTF-8 string). |
 | author  | required | Author of this entry. Required unless the author is set through the console or the IROH_AUTHOR environment variable. |
 
 
@@ -33,7 +33,7 @@ Set an entry in a document {{ className: 'lead' }}
 
 
 ```text {{ title: 'console' }}
-> docs create --use
+> doc create --use
 > set "key" "value"
 @ydzwyyes…: key = azceusiw… (5 B)
 ```
diff --git a/src/app/docs/commands/doc-share/page.mdx b/src/app/docs/commands/doc-share/page.mdx
@@ -21,8 +21,8 @@ Share a document with peers {{ className: 'lead' }}
 
 | name | necessity | description |
 | ---- | --------- | ----------- |
-| MODE  | required | one of &#39;read&#39; for Read-only access or &#39;write&#39; for Write access |
-| DOC_ID  | required | document to share. in the console the current document is used when no DOC_ID is provided |
+| MODE  | required | &#39;read&#39; for Read-only access or &#39;write&#39; for Write access |
+| DOC_ID  | required | document to share. In the console, the current document is used when no DOC_ID is provided. |
 
 
 
diff --git a/src/app/docs/ipfs/page.mdx b/src/app/docs/ipfs/page.mdx
@@ -6,13 +6,13 @@ export const metadata = {
 
 # iroh & IPFS
 
-Iroh is an _IPFS system_. It uses content identifiers (CIDs) Content addressing is a powerful primitive that belongs at the foundation of the internet. 
+Iroh is an _IPFS system_. It uses content identifiers (CIDs). Content addressing is a powerful primitive that belongs at the foundation of the internet. 
 
 Iroh is not an IPFS implementation. An implementation of IPFS should be able to interoperate with [kubo](https://github.com/ipfs/kubo) the reference implementation of nearly all [IPFS Specs](https://github.com/ipfs/specs). Iroh can interoperate with kubo by bridging the two technologies, but by default one shouldn't expect to be able to add content to kubo and get it out with iroh, or vice versa.
 
 ## Why not just make iroh an IPFS implementation?
 
-At first, we did! We wrote a ground-up implementation of IPFS in rust called [Beetle](https://github.com/n0-computer/beetle). We switched away because Iroh has different design goals than IPFS, and after writing an implementation, we realized couldn't achieve those goals & keep the implementation "badge'. Iroh aims to be the smallest working foundation for building apps with sublinear scaling. The word _small_ is the challenging one here. IPFS is designed to upgrade the _entire web_. To do that it has to accommodate numerous use cases and requirements that we couldn't build into Iroh while keeping the project small.
+At first, we did! We wrote a ground-up implementation of IPFS in rust called [Beetle](https://github.com/n0-computer/beetle). We switched away because Iroh has different design goals than IPFS, and after writing an implementation, we realized couldn't achieve those goals & keep the implementation 'badge'. Iroh aims to be the smallest working foundation for building apps with sublinear scaling. The word _small_ is the challenging one here. IPFS is designed to upgrade the _entire web_. To do that it has to accommodate numerous use cases and requirements that we couldn't build into iroh while keeping the project small.
 
 ## Comparison Table
 
@@ -100,4 +100,4 @@ Using translations requires trusting the author of the translation. The "author"
 
 ## Interop
 
-[iroh.network](https://iroh.network) anchors have configuration settings to automatically publish content the anchor has to kubo. As of now publishing to kubo only works on 1Mb files. We plan to implement both large file publishing and fetching in the future.
+[iroh.network](https://iroh.network) anchors have configuration settings to automatically publish content the anchor has to kubo. As of now publishing to kubo only works on 1Mb files. We plan to implement both large file publishing and fetching in the future.
diff --git a/src/app/docs/layers/blobs/page.mdx b/src/app/docs/layers/blobs/page.mdx
@@ -7,21 +7,21 @@ export const metadata = {
 
 Iroh works with _blobs_ of opaque data, which are often the bytes of a file. {{ className: 'lead' }}
 
-All blobs within Iroh are referred to by the BLAKE3 [1] hash of contents. BLAKE3 is a _tree hashing_ algorithm, that splits its input into uniform chunks and arranges them as the leaves of a binary tree, producing intermediate _chunk hashes_ that accumulate up to a _root hash._ Iroh uses the 32 byte root hash (or just “hash”) as an immutable blob identifier. 
+All blobs within iroh are referred to by the BLAKE3 [1] hash of its content. BLAKE3 is a _tree hashing_ algorithm, that splits its input into uniform chunks and arranges them as the leaves of a binary tree, producing intermediate _chunk hashes_ that accumulate up to a _root hash._ Iroh uses the 32 byte root hash (or just “hash”) as an immutable blob identifier. 
 
 <img class="figure" src="/design/content-addressing/fig_1_blob.svg" />
 
 We leverage the tree hash structure of BLAKE3 as a basis for incremental verification when data is sent over the network, as described by Section 6.4 “Verified Streaming” in [1] and implemented in [2]. Iroh caches all chunk hashes as external metadata, leaving the unaltered input blob as the canonical source of bytes. Verified streaming also facilitates _range requests:_ fetching a verifiable contiguous subsequence of a blob by streaming only the portions of the BLAKE3 binary tree required to verify the designated subsequence.
 
-Chunk hashes are distinct from root hashes, and only used during data transfer. The chunk size of BLAKE3 is a tunable constant that defaults to 1KiB, which results in a 6% overhead on on the size of the input blob. Increasing the chunk size reduces overhead, at the cost of requiring more data transfer before an incremental verification checkpoint is reached. The chunk size constant can be modified & recalculated *without affecting the root hash.* This opens the door to experiment with different chunk size constants, even at runtime. We intend to investigate chunk size optimization in future work.
+Chunk hashes are distinct from root hashes and only used during data transfer. The chunk size of BLAKE3 is a tunable constant that defaults to 1KiB, which results in a 6% overhead on on the size of the input blob. Increasing the chunk size reduces overhead, at the cost of requiring more data transfer before an incremental verification checkpoint is reached. The chunk size constant can be modified & recalculated *without affecting the root hash.* This opens the door to experiment with different chunk size constants, even at runtime. We intend to investigate chunk size optimization in future work.
 
-Root hashes are expressed as a Content identifier (CID) as defined in [3], making Iroh an *IPFS system* capable of interoperating with other systems that use CIDs. In contrast to other IPFS systems, only root hashes are valid content identifiers, which enforces a strict 1-1 relationship between a Content Identifier and blob. This 1-1 relationship brings Iroh into alignment with common whole-file checksum systems. A naive implementation of Iroh can skip verified streaming entirely and use the the CID as a whole-file checksum.
+Root hashes are expressed as a Content identifier (CID) as defined in [3], making iroh an *IPFS system* capable of interoperating with other systems that use CIDs. In contrast to other IPFS systems, only root hashes are valid content identifiers, which enforces a strict 1-1 relationship between a Content Identifier and blob. This 1-1 relationship brings iroh into alignment with common whole-file checksum systems. A naive implementation of iroh can skip verified streaming entirely and use the the CID as a whole-file checksum.
 
 ## Collections
 
 A *Collection* is an ordered set of named *links* to blobs. Collection link counts can range from 0-billions. Collections are the only means of relating blobs within iroh, and form the basis of synchronization & querying. Collections are true sets, and cannot be nested to form graphs. Internally collections are structured as a _radix tree_ [5] to support efficient prefix querying.
 
-A link is a triple of `name, CID`. *Name* is an opaque, arbitrary sequence of bytes that labels the link. These are typically UTF-8 strings, but are always treated and sorted as bytes. Names must be unique across the collection, and order the set. *CID* is the content identifier for the linked blob.
+A link is a tuple of `name, CID`. *Name* is an opaque, arbitrary sequence of bytes that labels the link. These are typically UTF-8 strings, but are always treated and sorted as bytes. Names must be unique across the collection, and order the set. *CID* is the content identifier for the linked blob.
 
 Collections have an optional _header_ section that stores the number of items in the collection and offsets to items within the list, forming a skip list index.
 
@@ -39,4 +39,4 @@ Collections are content addressed in the exact same manner as blobs, but use dif
 3. **CID (Content IDentifier): Self-describing content-addressed identifiers for distributed systems**<br />
 [https://github.com/multiformats/cid](https://github.com/multiformats/cid)
 4. **multihashes**<br />
-[https://multiformats.io/multihash/](https://multiformats.io/multihash/)
+[https://multiformats.io/multihash/](https://multiformats.io/multihash/)
diff --git a/src/app/docs/layers/documents/page.mdx b/src/app/docs/layers/documents/page.mdx
@@ -31,15 +31,15 @@ A key in a document is just a sequence of bytes. In practice keys are almost alw
 }
 ```
 
-An _entry_ in the document is a key-value pair. When an author writes an entry they first create a blob, then use the hash of the blob as the value, then pick a label to use as the key. Applications are encouraged
+An _entry_ in the document is a key-value pair. When an author writes an entry they first create a blob, then use the hash of the blob as the value, then pick a label to use as the key.
 
 ## Authors & Permissions
 
 Authors are users who have write access to a document. Every author has a keypair that represents their identity. The public side of a keypair identifies the user & validates the edits they make to the document, the private side of the keypair is used to sign edits.
 
-The author that created the document is the _document owner_. The owner holds the private side of the document keypair and does not share it. Document have the ability to destroy the document, and invite other authors to write to the document.
+The author that created the document is the _document owner_. The owner holds the private side of the document keypair and does not share it. Document owners have the ability to destroy the document and invite other authors to write to the document.
 
-Granting read access to a document is as simple as sharing the document public key. Any peer can then
+Granting read access to a document is as simple as sharing the document public key. 
 
 ## Syncing
 
@@ -63,4 +63,4 @@ Document IDs are base32-lower serialization of the public key of the document. T
 
 ## Subscriptions
 
-## Revocations & Key Rotations
+## Revocations & Key Rotations
diff --git a/src/app/docs/page.mdx b/src/app/docs/page.mdx
@@ -17,7 +17,7 @@ export const sections = [
 
 # Iroh Documentation
 
-Iroh is a protocol for syncing bytes. Bytes of any size, across any number of devices. Use iroh to apps that scale different. {{className: 'lead'}}
+Iroh is a protocol for syncing bytes. Bytes of any size, across any number of devices. Use iroh to create apps that scale different. {{className: 'lead'}}
 
 <div className="not-prose mb-16 mt-6 flex gap-3">
   <Button href="/docs/quickstart" arrow="right" children="Quickstart" />
diff --git a/src/app/docs/quickstart/page.mdx b/src/app/docs/quickstart/page.mdx
@@ -9,12 +9,12 @@ export const metadata = {
 This guide will give you a quick tour of iroh from the command line. We'll create a document and sync it between to terminals. After that we'll look at where to go next to learn about how iroh works & where to integrate into your application. {{className: 'lead'}}
 
 <Note>
-  Iroh is currently in alpha release. We're aiming for Sept. 30th for a proper, production quality release of this same API the quickstart covers.
+  Iroh is currently in alpha release. We're aiming for Sept. 30th for a proper, production quality release of the same API this quickstart covers.
 </Note>
 
 ## Install Iroh
 
-The first thing you'll need to do is get the iroh CLI. Follow the instructions on our [install guide](/docs/install), then come back here.
+The first thing you'll need to do is get the iroh CLI. Follow the instructions on our [install guide](/docs/install) to install iroh.
 
 <div className='not-prose'>
   <Button arrow="right" href="/docs/install">Install Iroh CLI</Button>
@@ -134,7 +134,6 @@ $ iroh --rpc-port 1111 console
 Welcome to the Iroh console!
 Type `help` for a list of commands.
 
-author:fhu3uk4w
 >
 ```
 
@@ -146,14 +145,14 @@ Now we can join the document from `Node B`, pasting in the value of the ticket w
 ksdx5fs4kwjmoaca2bod3z62vsm7ny42vubfxpczyr34trjvxp6q
 Active author is now ksdx5fs4…
 
-> doc join lzkcgw25utyfj3o4q5dbeo5tyevcjutr25nagmzi5yfsgtqoeohqcig35slag7ibfh3ddcls4szbl3k4q6m6d7gnrpgnv66tlnk3gktxaabqa3bjffy7riydabwcsklryrlqbqfikyrmivybae --switch
+> doc join --switch lzkcgw25utyfj3o4q5dbeo5tyevcjutr25nagmzi5yfsgtqoeohqcig35slag7ibfh3ddcls4szbl3k4q6m6d7gnrpgnv66tlnk3gktxaabqa3bjffy7riydabwcsklryrlqbqfikyrmivybae
 x5qffedimrovdpsr3andm3hdjo6g2nlaqstdm6oe3utblxsdh3eq
 Active doc is now x5qffedi…
 
 author:ksdx5fs4… doc:x5qffedi…
-> doc get bar -c
-@ksdx5fs4…: bar = atqlwopt… (3 B)
-foo
+> doc get foo -c
+@ksdx5fs4…: foo = 6lujp3wx… (3 B)
+bar
 ```
 </CodeGroup>
 
diff --git a/src/app/docs/sdks/page.mdx b/src/app/docs/sdks/page.mdx
@@ -12,6 +12,6 @@ export const sections = [
 
 # Iroh SDKs
 
-The recommended way to interact with the Iroh is by using one of our official Software Development Kits (SDKs). {{className: 'lead'}}
+The recommended way to interact with the iroh is by using one of our official Software Development Kits (SDKs). {{className: 'lead'}}
 
 <Libraries />

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ export const metadata = {`
`14`	`14`
`15`	`15`	`# author create`
`16`	`16`
`17`		`-Create a new author {{ className: 'lead' }}`
	`17`	`+Create a new author. {{ className: 'lead' }}`
`18`	`18`
`19`	`19`
`20`	`20`