Skip to content

Commit 2a7d8ed

Browse files
authored
docs: misc fixes (#308)
1 parent 56e8851 commit 2a7d8ed

File tree

7 files changed

+14
-13
lines changed

7 files changed

+14
-13
lines changed

docs/docs/core-concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Hypergraph takes knowledge graphs further by making them:
5050
- **⚡ Real-time** — Changes sync instantly across all your devices
5151
- **🔗 Interoperable** — Your data works across different apps that speak the same protocol
5252

53-
> **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.
53+
> **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.
5454
5555
## Spaces
5656

docs/docs/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ tags: [faq]
1111

1212
### What is Hypergraph?
1313

14-
> Hypergraph is a TypeScript-first framework for building local-first apps that sync encrypted data to a shared knowledge graph.
14+
> Hypergraph is a TypeScript-first framework for building local-first apps that syncs encrypted data to a shared knowledge graph.
1515
1616
### Does it replace my backend?
1717

docs/docs/key-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: [features, overview]
77

88
# 🌟 Key Features
99

10-
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.
10+
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.
1111

1212
## Table of Contents
1313

docs/docs/known-design-issues.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,27 @@
11
## Connect App
22

3-
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.
3+
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.
44

55
This could be mitigated by introducing an server‐side “registration” step for with the callback url and nonce directly from the app.
66

77
Alternatively a full OAuth2 flow would solve the issue.
88

99
## Space Info
1010

11-
Currently when decrypting the space info (name), there is no verification of the signature.
11+
When decrypting the space info (name), there is currently no signature verification.
1212

1313
## Responses
1414

1515
All responses in the sync server should be typed and encoded to avoid exposing data that is not intended to be exposed.
1616

1717
## Verifying the app identity in Connect
1818

19-
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.
19+
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.
2020

2121
## Sign app identity attached to spaces
2222

23-
Instead of trusting the sync-server the information that a app identity is attached to a space should be signed and verified.
23+
The information that for an app identity that is attached
24+
to a space should be signed and verified instead of trusting the sync-server.
2425

2526
## The Privy App Id should be stored only in .env files
2627

@@ -36,4 +37,4 @@ There should be multiple sessions with different session tokens so the user can
3637

3738
## Disabled Signature Verification
3839

39-
When switching to the Connect App authentication we temporaryily disabled signature verfication.
40+
Signature verification is currently temporarily disabled when switching to the Connect app authentication flow.

docs/docs/mapping.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Mapping
22

3-
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.
3+
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.
44

5-
This is done using a mapping structure that has to be provided to the `HypergraphAppProvider` component.
5+
This is done using an object called a mapping. The mapping has to be provided to the `HypergraphAppProvider` component.
66

7-
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:
7+
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`:
88

99
```tsx
1010
export const mapping: Mapping = {

docs/docs/spaces.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Spaces are owned by a single person or a group of people and not by the app. Thi
66

77
## Public Spaces
88

9-
Public spaces are spaces that are open to the public. They are accessible to anyone who knows the space ID.
9+
Public spaces are spaces that are open to the public. They are visible to anyone who knows the space ID.
1010

1111
## Private Spaces
1212

docs/docs/writing-private-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Writing Private Data
22

3-
There are serveral ways to write private data to the Hypergraph.
3+
There are several ways to write private data to the Hypergraph.
44

55
## Creating Entities
66

0 commit comments

Comments
 (0)