Skip to content

Commit caa35b2

Browse files
authored
Merge pull request #101 from ceramicnetwork/orbis-updates
Update the documentation to add Orbis Studio
2 parents a2f129e + bddc9ce commit caa35b2

5 files changed

Lines changed: 29 additions & 30 deletions

File tree

docs/introduction/intro.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ Ceramic is a decentralized data network that powers an ecosystem of interoperabl
88
## Introduction to Ceramic
99
---
1010

11-
- Head to the [**ComposeDB**](./composedb-overview.md) section to learn more about the stream-level layer of Ceramic network
11+
- Head to the [**OrbisDB**](./orbisdb-overview.md) section to learn more about the database products built on Ceramic that allow you to easily interact with the data stored on Ceramic using a simple and familiar SQL-based interface.
12+
13+
- Head to the [**ComposeDB**](./composedb-overview.md) section to learn more about stream-level Ceramic functionality.
1214

1315
- Head to the [**Ceramic Protocol**](./protocol-overview.md) section to learn about lower-level Ceramic functionality
1416

@@ -18,6 +20,10 @@ Ceramic is a decentralized data network that powers an ecosystem of interoperabl
1820

1921
---
2022

23+
### [**OrbisDB: advanced decentralized database with SQL interface→**](./orbisdb-overview.md)
24+
OrbisDB is an advanced decentralized database built on the Ceramic Data Network. It comes with a set of plugins allowing unlimited customization options.
25+
26+
2127
### [**ComposeDB: Graph DB for Web3 Apps →**](../composedb/getting-started)
2228

2329
ComposeDB is a decentralized graph database powered by Ceramic that enables you to build powerful Web3 applications using composable data, GraphQL, and reusable models. ComposeDB is the newest and most popular database built on Ceramic.

docs/introduction/orbisdb-overview.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,8 @@
22

33
OrbisDB is a simple and efficient gateway for storing and managing open data on Ceramic.
44

5-
OrbisDB provides a developer-friendly SQL interface to explore and query data on Ceramic as well as a user interface and plugin store to save development time on crypto-specific features – from data migration and token gating mechanisms to automated blockchain interactions.
5+
OrbisDB provides a developer-friendly SQL interface to explore and query data on Ceramic as well as a user interface and plugin store to save development time on crypto-specific features – from data migration and token gating mechanisms to automated blockchain interactions. It is built on Ceramic's new Data Feed API which makes it fully compatible with [ComposeDB](./composedb-overview).
66

7-
It is built on Ceramic's new Data Feed API which makes it fully compatible with [ComposeDB](./composedb-overview).
7+
OrbisDB comes with with a shared instance called [Orbis Studio](https://app.formo.so/hJ5VGyugmGigyVFyqdHJa), offering a simple experience to get started with building on Orbis and accessing plugins. [Get access to the Orbis Studio](https://app.formo.so/hJ5VGyugmGigyVFyqdHJa) (currently in Closed Beta) and start building!
88

99

10-
Check out more details about [OrbisDB](../orbisdb/overview) and [OrbisDB SDK](../orbisdb/orbisdb-sdk).

docs/orbisdb/overview.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# OrbisDB
22

3-
[OrbisDB](https://github.com/OrbisWeb3/orbisdb) is a developer-friendly interface to explore data with the ease of SQL and a plugin store to save development time on processes like data migration and gating mechanisms all the way to automated blockchain interactions.
3+
[OrbisDB](https://useorbis.com/) is a developer-friendly interface to explore data with the ease of SQL and a plugin store to save development time on processes like data migration and gating mechanisms all the way to automated blockchain interactions.
4+
5+
### How to get started?
6+
7+
OrbisDB comes with an easy-to-use shared instance called [Orbis Studio](https://app.formo.so/orbisdb-access-hJ5VGyugmGigyVFyqdHJa) which provides developers with a user-friendly interface to start interacting with data stored on Ceramic and use a library of available plugins right away without worrying about managing the backend requirements. [**Get access to Orbis Studio in closed beta and start building using OrbisDB**](https://app.formo.so/orbisdb-access-hJ5VGyugmGigyVFyqdHJa).
8+
9+
10+
11+
<div align="center"><iframe width="660" height="415" src="https://www.youtube.com/embed/gxHphFzkV3k?si=BY0iH78Y59-NmSrb" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
412

5-
OrbisDB is powered by Ceramic's Data Feed API which means that in order to interact with OrbisDB, you have to run a [Ceramic Node](../protocol/js-ceramic/nodes/running-a-node#install-and-run-the-ceramic-cli).
613

7-
OrbisDB comes with a easy-to-use [OrbisDB SDK](./orbisdb-sdk) for interacting with data.
814

915

1016
## Key components
@@ -20,6 +26,8 @@ OrbisDB consists of two main components - core and plugins.
2026
- Divided into 4 categories (Create streams, Add metadata, Validate and Post process). More details about plugins underneath.
2127

2228

23-
Start building using [OrbisDB](https://useorbis.com/).
29+
## OrbisDB SDK
30+
OrbisDB comes with a easy-to-use [OrbisDB SDK](./orbisdb-sdk) for writing the data to the OrbisDB instance as well as querying the data needed for your applications.
31+
2432

2533

src/components/homepage/start-building.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import styles from "./homeNavBoxes.module.css";
44

55
const FeatureList = [
66
{
7-
title: "Orbis →",
7+
title: "OrbisDB →",
88
items: [
99
{
1010
url: "https://useorbis.com/",

src/pages/index.js

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,9 @@ export default function Home() {
4040
background: "linear-gradient(215deg, var(--ifm-color-primary) -33%, var(--box-color) 50%)"
4141
}}
4242
>
43-
<h3>Build with ComposeDB</h3>
44-
<div>A decentralized, composable graph database to build interoperable applications on Ceramic.</div>
43+
<h3>Build with OrbisDB</h3>
44+
<div>OrbisDB is an advanced decentralized database built on the Ceramic Data Network. It comes with a set of
45+
plugins allowing unlimited customization options.</div>
4546
<div
4647
style={{
4748
display: "flex",
@@ -54,7 +55,7 @@ export default function Home() {
5455
}}
5556
>
5657
<div>
57-
<a href="/docs/composedb/getting-started">Getting Started </a>
58+
<a href="/docs/orbisdb/overview">Getting Started with OrbisDB → </a>
5859
</div>
5960
</div>
6061
</div>
@@ -64,10 +65,9 @@ export default function Home() {
6465
background: "linear-gradient(215deg, #660094 -33%, var(--box-color) 50%)"
6566
}}
6667
>
67-
<h3>Build with OrbisDB</h3>
68+
<h3>Build with ComposeDB</h3>
6869
<div>
69-
OrbisDB is an advanced decentralized database built on the Ceramic Data Network. It comes with a set of
70-
plugins allowing unlimited customization options.
70+
A decentralized, composable graph database to build interoperable applications on Ceramic.
7171
</div>
7272
<div
7373
style={{
@@ -81,21 +81,7 @@ export default function Home() {
8181
}}
8282
>
8383
<div>
84-
<a href="https://useorbis.com/" target="_blank">
85-
Get started with OrbisDB{" "}
86-
<svg
87-
width="13.5"
88-
height="13.5"
89-
aria-hidden="true"
90-
viewBox="0 0 24 24"
91-
class="iconExternalLink_node_modules--pnpm-@docusaurus+theme-classic@3-0-0_@types+react@18-2-37_eslint@8-53-0_react-dom@18-2-0_react@18-2-0_typescript@5-2-2-node_modules-@docusaurus-theme-classic-lib-theme-Icon-ExternalLink-styles-module"
92-
>
93-
<path
94-
fill="currentColor"
95-
d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"
96-
></path>
97-
</svg>
98-
</a>
84+
<a href="/docs/composedb/getting-started">Getting Started → </a>
9985
</div>
10086
</div>
10187
</div>

0 commit comments

Comments
 (0)