Skip to content

Commit fe83b37

Browse files
authored
Extending docs - added blog entry and improved design (#209)
1 parent 4e4727e commit fe83b37

File tree

11 files changed

+278
-167
lines changed

11 files changed

+278
-167
lines changed

docs/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati
99
Install all dependencies from the monorepo root:
1010

1111
```
12-
$ pnpm install
12+
pnpm install
1313
```
1414

1515
### Local Development
1616

1717
Start the Docusaurus dev server for the docs site:
1818

1919
```
20-
$ pnpm --filter docs start
20+
pnpm --filter docs start
2121
```
2222

2323
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
@@ -27,7 +27,7 @@ This command starts a local development server and opens up a browser window. Mo
2727
Build the static site:
2828

2929
```
30-
$ pnpm --filter docs build
30+
pnpm --filter docs build
3131
```
3232

3333
This command generates static content into the `build` directory and can be served using any static content hosting service.
@@ -37,13 +37,13 @@ This command generates static content into the `build` directory and can be serv
3737
Using SSH:
3838

3939
```
40-
$ USE_SSH=true pnpm --filter docs deploy
40+
USE_SSH=true pnpm --filter docs deploy
4141
```
4242

4343
Not using SSH:
4444

4545
```
46-
$ GIT_USER=<Your GitHub username> pnpm --filter docs deploy
46+
GIT_USER=<Your GitHub username> pnpm --filter docs deploy
4747
```
4848

4949
If you are using GitHub Pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/blog/2019-05-28-first-blog-post.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/blog/2019-05-29-long-blog-post.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 24 deletions
This file was deleted.
-93.9 KB
Binary file not shown.

docs/blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 29 deletions
This file was deleted.
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
slug: hypergraph-alpha-released
3+
title: Announcing Hypergraph - A New Chapter in Web Development
4+
date: 2025-06-11
5+
authors: [nik, pablo]
6+
tags: [release, alpha, hypergraph]
7+
---
8+
9+
After months of development and countless conversations with developers like you, **we're thrilled to unveil the Alpha version of Hypergraph**. This is more than just another data layer—it's a fundamental rethinking of how we build collaborative, secure, and offline-first Web3 applications.
10+
11+
<!-- truncate -->
12+
13+
## Why We Built Hypergraph
14+
15+
The challenges of modern app development are clear: users expect real-time collaboration, bulletproof security, and apps that work flawlessly even when offline. Traditional architectures force uncomfortable trade-offs between these needs. We knew there had to be a better way.
16+
17+
Enter Hypergraph, built on two core innovations: a local-first architecture that puts your data where it belongs—on the client—and our implementation of the GRC-20 standard for truly composable knowledge graphs.
18+
19+
<!-- TODO: ADD IMAGE OF HYPGRAPH UI -->
20+
21+
## What Makes Hypergraph Different
22+
23+
At its heart, Hypergraph is local-first. Every piece of data is stored on the client, making reads and writes instant—no waiting for server responses. When you're online, our CRDT-based sync ensures your data flows seamlessly between devices and collaborators. When you're offline? Everything just works.
24+
25+
Security isn't an afterthought—it's built into our foundation. With end-to-end encryption, your data is only readable by those you explicitly trust. No intermediaries, no compromises.
26+
27+
The real magic happens with our GRC-20 Knowledge Graph. It's not just a data format; it's a new way of thinking about how information connects and flows through your applications. Every mutation, whether it's adding a note or updating a relationship, becomes part of a larger, interoperable knowledge network.
28+
29+
<!-- TODO: ADD GIF OF DATA MODEL -->
30+
31+
## Looking Ahead
32+
33+
We're launching this alpha today, June 10, 2025, and we're targeting a beta release in August. Our roadmap to a stable release in Q4 2025 is ambitious but achievable with your help. The beta will bring enhanced stability, an expanded API surface, and comprehensive documentation based on your feedback.
34+
35+
## Join the Alpha Today
36+
37+
Getting started is simple. Install our SDK:
38+
39+
```bash
40+
# TODO: ADD INSTALLER TO NPM npm install @hypergraph/sdk-alpha
41+
```
42+
43+
Head to our [Quickstart guide](/docs/quickstart) to build your first Hypergraph app, or dive deep into our [API Reference](/docs/api-reference) to explore the possibilities. We support Node.js and modern browsers, with React hooks that make integration a breeze.
44+
45+
## A Note on What to Expect
46+
47+
Let's be transparent: this is an alpha release. You'll see rapid changes as we iterate based on your feedback. Some features are still experimental, and you might encounter sync delays with larger graphs or limited support on mobile browsers. But that's exactly why we need you—every bug report, feature request, and question helps shape Hypergraph's future.
48+
49+
## Let's Build Together
50+
51+
Your voice matters in this journey. Share your experiences, report issues, or just chat with us:
52+
53+
- Found a bug? [Open an issue on GitHub](https://github.com/graphprotocol/hypergraph/issues)
54+
<!-- TODO: Get /discussions set up in github - Have ideas? Join the discussion on [GitHub Discussions](https://github.com/graphprotocol/hypergraph/discussions) -->
55+
- Want to chat? Find us on [Discord](https://discord.gg/graphprotocol)
56+
57+
We read every message and your feedback directly shapes our roadmap.
58+
59+
## Ready to Shape the Future?
60+
61+
This is just the beginning. Hypergraph represents our vision for the future of Web3 development, but it's your creativity and feedback that will help us realize its full potential. [Get started with the Quickstart](/docs/quickstart), and explore our [API Reference](/docs/api-reference), and join us in building the next generation of collaborative, decentralized applications.
62+
63+
We can't wait to see what you'll create.

docs/blog/authors.yml

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
yangshun:
2-
name: Yangshun Tay
3-
title: Front End Engineer @ Facebook
4-
url: https://github.com/yangshun
5-
image_url: https://github.com/yangshun.png
1+
pablo:
2+
name: Pablo Carranza Velez
3+
title: Engineering Manager @ Edge & Node
4+
url: https://github.com/pcarranzav
5+
image_url: https://avatars.githubusercontent.com/u/2223590?v=4
6+
permalink: /all-pablo-articles
67
page: true
78
socials:
8-
x: yangshunz
9-
github: yangshun
9+
x: https://x.com/pcarranzav
10+
github: https://github.com/pcarranzav
1011

11-
slorber:
12-
name: Sébastien Lorber
13-
title: Docusaurus maintainer
14-
url: https://sebastienlorber.com
15-
image_url: https://github.com/slorber.png
12+
nik:
13+
name: Nik
14+
title: Hypergraph Lead Engineer @ Geo
15+
# url:
16+
image_url: https://ca.slack-edge.com/T047DS7N1PE-U07PPQ3GN7Q-gafcee4ad6e3-512
1617
page:
17-
# customize the url of the author page at /blog/authors/<permalink>
18-
permalink: '/all-sebastien-lorber-articles'
19-
socials:
20-
x: sebastienlorber
21-
linkedin: sebastienlorber
22-
github: slorber
23-
newsletter: https://thisweekinreact.com
18+
permalink: /all-nik-articles
19+
# socials:
20+
# x:
21+
# linkedin:
22+
# github:
23+
# newsletter: https://thisweekinreact.com

docs/blog/tags.yml

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,40 @@
1-
facebook:
2-
label: Facebook
3-
permalink: /facebook
4-
description: Facebook tag description
5-
6-
hello:
7-
label: Hello
8-
permalink: /hello
9-
description: Hello tag description
10-
111
docusaurus:
122
label: Docusaurus
133
permalink: /docusaurus
144
description: Docusaurus tag description
155

16-
hola:
17-
label: Hola
18-
permalink: /hola
19-
description: Hola tag description
6+
release:
7+
label: Release
8+
permalink: /release
9+
description: Release announcements and updates
10+
11+
alpha:
12+
label: Alpha
13+
permalink: /alpha
14+
description: Alpha version releases and features
15+
16+
hypergraph:
17+
label: Hypergraph
18+
permalink: /hypergraph
19+
description: Posts about Hypergraph features and updates
20+
21+
knowledge-graphs:
22+
label: Knowledge Graphs
23+
permalink: /knowledge-graphs
24+
description: Articles about knowledge graph concepts, best practices, and implementation
25+
26+
education:
27+
label: Education
28+
permalink: /education
29+
description: Educational content and tutorials
30+
31+
best-practices:
32+
label: Best Practices
33+
permalink: /best-practices
34+
description: Guidelines, conventions, and recommended practices
35+
36+
grc20:
37+
label: GRC-20
38+
permalink: /grc20
39+
description: Content related to the GRC-20 knowledge graph specification
40+

docs/docusaurus.config.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ const config = {
4949
},
5050
blog: {
5151
showReadingTime: true,
52+
blogSidebarCount: 'ALL',
5253
feedOptions: {
5354
type: ['rss', 'atom'],
5455
xslt: true,
@@ -71,6 +72,7 @@ const config = {
7172
themeConfig:
7273
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
7374
({
75+
colorMode: { defaultMode: 'dark', disableSwitch: true },
7476
// Replace with your project's social card
7577
image: 'img/docusaurus-social-card.jpg',
7678
navbar: {

0 commit comments

Comments
 (0)