Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the documentation to add Orbis Studio #101

Merged
merged 2 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/introduction/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ Ceramic is a decentralized data network that powers an ecosystem of interoperabl
## Introduction to Ceramic
---

- Head to the [**ComposeDB**](./composedb-overview.md) section to learn more about the stream-level layer of Ceramic network
- 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.

- Head to the [**ComposeDB**](./composedb-overview.md) section to learn more about stream-level Ceramic functionality.

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

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

---

### [**OrbisDB: advanced decentralized database with SQL interface→**](./orbisdb-overview.md)
OrbisDB is an advanced decentralized database built on the Ceramic Data Network. It comes with a set of plugins allowing unlimited customization options.


### [**ComposeDB: Graph DB for Web3 Apps →**](../composedb/getting-started)

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.
Expand Down
5 changes: 2 additions & 3 deletions docs/introduction/orbisdb-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

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

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.
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).

It is built on Ceramic's new Data Feed API which makes it fully compatible with [ComposeDB](./composedb-overview).
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!


Check out more details about [OrbisDB](../orbisdb/overview) and [OrbisDB SDK](../orbisdb/orbisdb-sdk).
16 changes: 12 additions & 4 deletions docs/orbisdb/overview.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# OrbisDB

[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.
[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.

### How to get started?

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).



<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>

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).

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


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


Start building using [OrbisDB](https://useorbis.com/).
## OrbisDB SDK
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.



2 changes: 1 addition & 1 deletion src/components/homepage/start-building.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import styles from "./homeNavBoxes.module.css";

const FeatureList = [
{
title: "Orbis →",
title: "OrbisDB →",
items: [
{
url: "https://useorbis.com/",
Expand Down
28 changes: 7 additions & 21 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ export default function Home() {
background: "linear-gradient(215deg, var(--ifm-color-primary) -33%, var(--box-color) 50%)"
}}
>
<h3>Build with ComposeDB</h3>
<div>A decentralized, composable graph database to build interoperable applications on Ceramic.</div>
<h3>Build with OrbisDB</h3>
<div>OrbisDB is an advanced decentralized database built on the Ceramic Data Network. It comes with a set of
plugins allowing unlimited customization options.</div>
<div
style={{
display: "flex",
Expand All @@ -54,7 +55,7 @@ export default function Home() {
}}
>
<div>
<a href="/docs/composedb/getting-started">Getting Started </a>
<a href="/docs/orbisdb/overview">Getting Started with OrbisDB → </a>
</div>
</div>
</div>
Expand All @@ -64,10 +65,9 @@ export default function Home() {
background: "linear-gradient(215deg, #660094 -33%, var(--box-color) 50%)"
}}
>
<h3>Build with OrbisDB</h3>
<h3>Build with ComposeDB</h3>
<div>
OrbisDB is an advanced decentralized database built on the Ceramic Data Network. It comes with a set of
plugins allowing unlimited customization options.
A decentralized, composable graph database to build interoperable applications on Ceramic.
</div>
<div
style={{
Expand All @@ -81,21 +81,7 @@ export default function Home() {
}}
>
<div>
<a href="https://useorbis.com/" target="_blank">
Get started with OrbisDB{" "}
<svg
width="13.5"
height="13.5"
aria-hidden="true"
viewBox="0 0 24 24"
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"
>
<path
fill="currentColor"
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"
></path>
</svg>
</a>
<a href="/docs/composedb/getting-started">Getting Started → </a>
</div>
</div>
</div>
Expand Down
Loading