Skip to content

Commit fb05e96

Browse files
authored
Merge branch 'main' into pranavdaa/docs-update
2 parents 5f4877e + 4dbee83 commit fb05e96

6 files changed

Lines changed: 14 additions & 6 deletions

File tree

docs/docs/authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Geo Connect
44

5-
The default and recommended way to authenticate is via Geo Connect. Geo Connect is dedicated application hosted by the GeoBrowser team. Through Geo Connect you can authenticate with your GeoBrowser account and use it to selectively delegate access to your private and public spaces.
5+
The default and recommended way to authenticate is via Geo Connect. Geo Connect is a dedicated application hosted by the GeoBrowser team. Through Geo Connect you can authenticate with your GeoBrowser account and use it to selectively delegate access to your private and public spaces.
66

77
If you create you application using TypeSync or use the [hypergraph-app-template](https://github.com/geobrowser/hypergraph-app-template) the full authentication flow is already implemented for you.
88

docs/docs/key-features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Data is **persisted first on the client**—not on a remote database. Users can
3636

3737
Every update is encrypted **on the client** using XChaCha20-Poly1305. Only members of a Space possess the symmetric key, so neither the sync server nor The Graph can read private data.
3838

39-
* **Automatic key rotation** when members join/leave (not yet implemented).
39+
* **Automatic key rotation**: when members join/leave (not yet implemented).
4040
* **Multi-device**: each device holds its own key pair.
4141

4242
## Knowledge Graph SDK

docs/docs/mapping.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,7 @@ The entire mapping structure can be generated using the TypeSync tool.
3131
pnpm install -g @graphprotocol/hypergraph-cli@latest
3232
hg typesync --open
3333
```
34+
35+
## Mapping Examples
36+
37+
You can search for dozens of schema/mapping examples on the [Hypergraph Schema Browser](https://schema-browser.vercel.app/).

docs/docs/providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ const App = () => {
5656
5757
## HypergraphSpaceProvider
5858
59-
Whenever interact with a space you need to provide the space ID. In order providing the space ID to every hook e.g. useSpace, useQuery, useCreateEntity, etc. you can use the `HypergraphSpaceProvider` to wrap a section of your app with the space ID.
59+
Whenever you interact with a space you need to provide the space ID. In order providing the space ID to every hook e.g. useSpace, useQuery, useCreateEntity, etc. you can use the `HypergraphSpaceProvider` to wrap a section of your app with the space ID.
6060
6161
```tsx
6262
import { HypergraphSpaceProvider } from "@graphprotocol/hypergraph-react";

docs/docs/schema.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Schema
22

3-
The Hypergraph schema allows you define the data model for your application. It is based on the GRC-20 specification and allows you to define Types with properties and relations to other Types.
3+
The Hypergraph schema allows you to define the data model for your application. It is based on the GRC-20 specification and allows you to define Types with properties and relations to other Types.
44

55
## Example
66

@@ -54,4 +54,8 @@ export class Company extends Entity.Class<Company>('Company')({
5454
active: Type.Checkbox,
5555
location: Type.Point,
5656
}) {}
57-
```
57+
```
58+
59+
## Schema Examples
60+
61+
You can search for dozens of schema/mapping examples on the [Hypergraph Schema Browser](https://schema-browser.vercel.app/).

docs/docs/space-invitations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const { listInvitations } = useHypergraphApp();
2323
listInvitations();
2424
```
2525

26-
Once the functions is called the invitations are requested from and are available in the Hypergraph store.
26+
Once the function is called the invitations are requested from and are available in the Hypergraph store.
2727

2828
```tsx
2929
import { useSelector } from "@xstate/store/react";

0 commit comments

Comments
 (0)