Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
neriumrevolta committed Jul 21, 2023
1 parent 734998b commit 6bab4eb
Show file tree
Hide file tree
Showing 10 changed files with 49 additions and 47 deletions.
2 changes: 1 addition & 1 deletion docs/graphcast/design-principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# ⚙️ Design Principles
# Design Principles

There are two main components of Graphcast

Expand Down
2 changes: 1 addition & 1 deletion docs/graphcast/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# 👋 Introduction
# Introduction

Is there something you'd like to learn from or share with your fellow Indexers in an automated manner, but it's too much hassle or costs too much gas?

Expand Down
2 changes: 1 addition & 1 deletion docs/graphcast/radios/3la-monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# 📟 3LA - Network Radio
# 3LA - Listener Radio

The source code for 3LA is available [on GitHub](https://github.com/graphops/graphcast-3la) and Docker builds are automatically published as [GitHub Packages](https://github.com/graphops/graphcast-3la/pkgs/container/graphcast-3la).

Expand Down
8 changes: 4 additions & 4 deletions docs/graphcast/radios/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "📻 Radios",
"collapsed": false,
"position": 4
}
"label": "Radios",
"collapsed": false,
"position": 4
}
2 changes: 1 addition & 1 deletion docs/graphcast/radios/one-shot.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 3
---

# 📟 One-shot CLI
# One-shot CLI

The source code for the one-shot CLI is available [on GitHub](https://github.com/graphops/subgraph-radio/tree/dev/one-shot) as a member of the Subgraph Radio workspace.

Expand Down
64 changes: 33 additions & 31 deletions docs/graphcast/radios/subgraph-radio.md

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/graphcast/sdk/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "🧰 SDK",
"collapsed": false,
"position": 3
}
"label": "SDK",
"collapsed": false,
"position": 3
}
4 changes: 2 additions & 2 deletions docs/graphcast/sdk/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
sidebar_position: 1
---

# 👋 Introduction
# Introduction

Graphcast SDK is a decentralized, distributed peer-to-peer (P2P) communication tool that enables users across the network to exchange information in real-time. It is designed to overcome the high cost of signaling or coordination between blockchain participants by enabling off-chain communication (gossip/cheap talk). This is particularly useful for applications where real-time communication is essential but the cost of on-chain transactions is prohibitive.
Graphcast SDK is a decentralized, distributed peer-to-peer (P2P) communication tool that enables users across the network to exchange information in real-time. It is designed to overcome the high cost of signaling or coordination between blockchain participants by enabling off-chain communication (gossip/cheap talk). This is particularly useful for applications where real-time communication is essential but the cost of on-chain transactions is prohibitive.

## How it Works

Expand Down
2 changes: 1 addition & 1 deletion docs/graphcast/sdk/radio-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# 🧑‍💻 Radio Development
# Radio Development

Do you want to build robust, peer-to-peer messaging apps that automatically exchange valuable data with other Indexers in real time? Do you have an idea for what data could be useful to share that could lead to greater communication efficiency in The Graph network as a whole? Then you want to build a Radio on top of the Graphcast network.

Expand Down
2 changes: 1 addition & 1 deletion docs/graphcast/sdk/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 2
---

# 📖 Registry
# Registry

The Graphcast Registry contracts allow an address to set a `GraphcastID` by calling `setGraphcastID(indexer_address, graphcastID_address)` as either an Indexer or an Indexer operator, or calling `setGraphcastID(graphcastID_address)` as the Indexer address. The relationship between an Indexer address to its GraphcastID is limited to 1:1, and cannot be set to itself. This restriction provides consistency and security for the Indexer identity to operate on Graphcast as one GraphcastID operating across Radio applications. To learn more about the registry, you can check out [the Github repository](https://github.com/graphops/graphcast-registry).

Expand Down

0 comments on commit 6bab4eb

Please sign in to comment.