Skip to content
This repository was archived by the owner on Mar 31, 2022. It is now read-only.

Learn documentation spelling fixes #26

Open
lukezsmith wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Learn documentation spelling fixes #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
30401b6
learn docs spelling fixes
lukezsmith Mar 30, 2022
4cf85e9
updated definitionID markdown link
lukezsmith Mar 30, 2022
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
10 changes: 5 additions & 5 deletions docs/learn/glossary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

### **Index**

The index is a key-value store stream that stores a list of [definitionID](#definitionid) to [recordID](#recordid) mappings. These mappings repreresent all of the data owned by a given DID. The index is the core component of IDX and each [DID](#did) has only one.
The index is a key-value store stream that stores a list of [definitionID](#definitionid) to [recordID](#recordid) mappings. These mappings represent all of the data owned by a given DID. The index is the core component of IDX and each [DID](#did) has only one.

=== "Example index"

Expand All @@ -21,7 +21,7 @@ The index is a key-value store stream that stores a list of [definitionID](#defi

### **Definition**

A definition is a stream which describes a [record](#record) and its [definitionID](#definitionid) acts as a key in the [index](#index). Definitions contain a [schema](#schema) and other metadata about a record. Definitions are created once by developers and the defiinitionID can be reused as a key in any number of indexes.
A definition is a stream which describes a [record](#record) and its [definitionID](#definitionid) acts as a key in the [index](#index). Definitions contain a [schema](#schema) and other metadata about a record. Definitions are created once by developers and the [definitionID](#definitionid) can be reused as a key in any number of indexes.

=== "Example definition"

Expand All @@ -35,7 +35,7 @@ A definition is a stream which describes a [record](#record) and its [definition

### **Schema**

A schema is a stream that contain a [JSON schema](https://json-schema.org/). The [schemaURL](#schemaurl) of the schema is included in a [definition](#definition) and is used to enforce the data format of a [record](#record).
A schema is a stream that contains a [JSON schema](https://json-schema.org/). The [schemaURL](#schemaurl) of the schema is included in a [definition](#definition) and is used to enforce the data format of a [record](#record).

=== "Example schema"

Expand Down Expand Up @@ -155,7 +155,7 @@ A schema is a stream that contain a [JSON schema](https://json-schema.org/). The

### **Record**

A record is a stream which contains the JSON data described by a [definition](#definition). The [recordID](#recordid) of the record acts as a value in the [index](#index). Records are unique to users, so different users will have different records for the same definitionID. Records are entirely flexible to your use case, but many developers use them to store content or references to content.
A record is a stream which contains the JSON data described by a [definition](#definition). The [recordID](#recordid) of the record acts as a value in the [index](#index). Records are unique to users, so different users will have different records for the same [definitionID](#definitionid). Records are entirely flexible to your use case, but many developers use them to store content or references to content.

#### Storage

Expand Down Expand Up @@ -202,7 +202,7 @@ An alias is an application-level construct that makes it easy to reference and i

### **DID**

DIDs is the [W3C standard](https://www.w3.org/TR/did-core/) for gloablly unique decentralized identifiers. IDX uses DIDs for user identifiers and authentication. There currently are more than 60+ implementations of DIDs, called methods. IDX supports any DID method. Learn more about DIDs in the [Ceramic documentation](https://developers.ceramic.network).
DIDs is the [W3C standard](https://www.w3.org/TR/did-core/) for globally unique decentralized identifiers. IDX uses DIDs for user identifiers and authentication. There currently are more than 60+ implementations of DIDs, called methods. IDX supports any DID method. Learn more about DIDs in the [Ceramic documentation](https://developers.ceramic.network).

=== "Example DID"

Expand Down
2 changes: 1 addition & 1 deletion docs/learn/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ A [record](glossary.md#record) is a stream which contains data specified by a de
### Reading records

1. Developer queries an [index](#index) using a [DID](glossary.md#did) and a [definitionID](glossary.md#definitionid) or [alias](glossary.md#alias).
1. Developer gets back the [record](#record) that corresponds to the definitionID.
1. Developer gets back the [record](#record) that corresponds to the [definitionID](glossary.md#definitionid).

> Learn more about [reading records](../build/reading.md).

Expand Down