diff --git a/docs/docs/core-concepts.md b/docs/docs/core-concepts.md index 44ab7dfe..6dda57aa 100644 --- a/docs/docs/core-concepts.md +++ b/docs/docs/core-concepts.md @@ -50,7 +50,7 @@ Hypergraph takes knowledge graphs further by making them: - **⚡ Real-time** — Changes sync instantly across all your devices - **🔗 Interoperable** — Your data works across different apps that speak the same protocol -> **The magic:** Under the hood, Hypergraph serializes everything using the **GRC-20** standard. As a developer, you just work with simple SDK calls—Hypergraph handles the complex cryptography and networking. If you're curious about the low-level details, check out the [GRC-20 section](#grc-20-advanced) below. +> **The magic:** Under the hood, Hypergraph serializes everything using the **GRC-20** standard. As a developer, you just work with simple SDK calls—Hypergraph handles the complex cryptography, serialization, and networking. If you're curious about the low-level details, check out the [GRC-20 section](#grc-20-advanced) below. ## Spaces diff --git a/docs/docs/faq.md b/docs/docs/faq.md index b751aa83..2227f31b 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -11,7 +11,7 @@ tags: [faq] ### What is Hypergraph? -> Hypergraph is a TypeScript-first framework for building local-first apps that sync encrypted data to a shared knowledge graph. +> Hypergraph is a TypeScript-first framework for building local-first apps that syncs encrypted data to a shared knowledge graph. ### Does it replace my backend? diff --git a/docs/docs/key-features.md b/docs/docs/key-features.md index 759d571a..4d69de61 100644 --- a/docs/docs/key-features.md +++ b/docs/docs/key-features.md @@ -7,7 +7,7 @@ tags: [features, overview] # 🌟 Key Features -Hypergraph is **more than a database**—it's a complete data layer for building collaborative, local-first apps. Below is a concise tour of the capabilities you get out of the box. +Hypergraph is **more than a database**—it's a complete data layer for building collaborative, local-first apps. Below is a tour of the capabilities you get out of the box. ## Table of Contents diff --git a/docs/docs/known-design-issues.md b/docs/docs/known-design-issues.md index ec9015aa..6333d3b4 100644 --- a/docs/docs/known-design-issues.md +++ b/docs/docs/known-design-issues.md @@ -1,6 +1,6 @@ ## Connect App -Currently when authenticating with the Conncet app, the app will send a callback url to the server. An attacker could intercept this callback url and redirect the user to a malicious site. +When authenticating with the Connect app, the app will send a callback url to the server. An attacker could intercept this callback url and redirect the user to a malicious site. This could be mitigated by introducing an server‐side “registration” step for with the callback url and nonce directly from the app. @@ -8,7 +8,7 @@ Alternatively a full OAuth2 flow would solve the issue. ## Space Info -Currently when decrypting the space info (name), there is no verification of the signature. +When decrypting the space info (name), there is currently no signature verification. ## Responses @@ -16,11 +16,12 @@ All responses in the sync server should be typed and encoded to avoid exposing d ## Verifying the app identity in Connect -Instead of trusting the server with the app identity address either each app-identity should be signed or the address also be stored in the ciphertext containing private keys. +Instead of trusting the server with the app identity address each app-identity should be signed or the address should be stored in the ciphertext containing private keys. ## Sign app identity attached to spaces -Instead of trusting the sync-server the information that a app identity is attached to a space should be signed and verified. +The information that for an app identity that is attached +to a space should be signed and verified instead of trusting the sync-server. ## The Privy App Id should be stored only in .env files @@ -36,4 +37,4 @@ There should be multiple sessions with different session tokens so the user can ## Disabled Signature Verification -When switching to the Connect App authentication we temporaryily disabled signature verfication. \ No newline at end of file +Signature verification is currently temporarily disabled when switching to the Connect app authentication flow. \ No newline at end of file diff --git a/docs/docs/mapping.md b/docs/docs/mapping.md index 9c0da73c..7c89f770 100644 --- a/docs/docs/mapping.md +++ b/docs/docs/mapping.md @@ -1,10 +1,10 @@ # Mapping -The public knowledge graph is based on property IDs. In order to integrate with the public knowledge graph you need to map your own schema to ID based public graph schema. +The public knowledge graph is based on property IDs. In order to integrate with the public knowledge graph you need to map your own schema to IDs from the public graph's schema. -This is done using a mapping structure that has to be provided to the `HypergraphAppProvider` component. +This is done using an object called a mapping. The mapping has to be provided to the `HypergraphAppProvider` component. -A mapping entry defined the type IDs, properties and relations of a type. Here an exmaple mapping entry for the `Event` and `Company` schema entries: +A mapping entry defined the type IDs, properties and relations of a type. Here an example mapping for a schema with an `Event` and a `Company`: ```tsx export const mapping: Mapping = { diff --git a/docs/docs/spaces.md b/docs/docs/spaces.md index 0d56b241..abed2d22 100644 --- a/docs/docs/spaces.md +++ b/docs/docs/spaces.md @@ -6,7 +6,7 @@ Spaces are owned by a single person or a group of people and not by the app. Thi ## Public Spaces -Public spaces are spaces that are open to the public. They are accessible to anyone who knows the space ID. +Public spaces are spaces that are open to the public. They are visible to anyone who knows the space ID. ## Private Spaces diff --git a/docs/docs/writing-private-data.md b/docs/docs/writing-private-data.md index 12d52750..316f962b 100644 --- a/docs/docs/writing-private-data.md +++ b/docs/docs/writing-private-data.md @@ -1,6 +1,6 @@ # Writing Private Data -There are serveral ways to write private data to the Hypergraph. +There are several ways to write private data to the Hypergraph. ## Creating Entities