Skip to content

Commit 53cd9fc

Browse files
authored
Improve schema and core concepts docs (#472)
1 parent f5d40fe commit 53cd9fc

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

docs/docs/core-concepts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,10 @@ When the event log grows large, a peer may emit `sendCompactedUpdate`—a snapsh
114114
| Stale clients | Each event carries `lastKnownSpaceEventId`; server rejects out-of-date mutations. |
115115
| Key leakage on member removal | **Key rotation** through `removeMember` → generates a new `spaceKey`. |
116116

117+
## How Can I Explore a Space's Data?
118+
119+
You can browse a space's data using [Geo Browser's Testnet](https://testnet.geobrowser.io/root). Simply enter the Space ID you want to explore into the search bar to view its contents. If you do not have access to the data due to privacy restrictions, you will not be able to view the data.
120+
117121
## GRC-20: The Protocol Under the Hood
118122

119123
> **⚠️ Advanced Section:** You don't need to understand GRC-20 to build with Hypergraph! This is for developers who want to understand the underlying protocol or need low-level access to the knowledge graph.

docs/docs/schema.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@
22

33
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

5+
## Hypergraph Schema Browser
6+
7+
Building your app using a schema that is already actively used in Hypergraph's knowledge graph unlocks composability between your dataset and other datasets used in Hypergraph's knowledge graph.
8+
9+
You can search for schemas used within the Hypergraph knowledge graph using the [Hypergraph Schema Browser](https://schema-browser.vercel.app/).
10+
511
## Example
612

7-
Here is an example of a schema for an Event app with the properties `name` and `description`.
13+
Here is an example of a schema for an Event entity with the properties `name` and `description`.
814

915
```ts
1016
import { Entity, Type } from '@graphprotocol/hypergraph';
@@ -69,7 +75,3 @@ export class Company extends Entity.Class<Company>('Company')({
6975
founded: Type.optional(Type.Date),
7076
}) {}
7177
```
72-
73-
## Schema Examples
74-
75-
You can search for dozens of schema/mapping examples on the [Hypergraph Schema Browser](https://schema-browser.vercel.app/).

0 commit comments

Comments
 (0)