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

Add OrbisDB to the documentation #70

Merged
merged 3 commits into from
Feb 27, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
2 changes: 1 addition & 1 deletion docs/introduction/composedb-overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ComposeDB Docs
# ComposeDB
![Introduction](/img/intro-dataverse.png)

ComposeDB is a composable graph database built on [Ceramic](https://ceramic.network), designed for Web3 applications.
Expand Down
10 changes: 10 additions & 0 deletions docs/introduction/orbisdb-overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# OrbisDB

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.

It is built on Ceramic's new Data Feed API which makes it fully compatible with [ComposeDB](./composedb-overview).


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

OrbisDB comes with an [OrbisDB SDK](https://github.com/OrbisWeb3/db-sdk) which makes it easy to create, manage and query open data.

OrbisDB SDK is a client-side complement to OrbisDB - a decentralized database built on top of Ceramic. It enables simple user authentication and provides necessary methods to manipulate the data.

Head to the [OrbisDB SDK Github repository](https://github.com/OrbisWeb3/db-sdk) to start interacting with OrbisDB SDK.

25 changes: 25 additions & 0 deletions docs/orbisdb/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 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 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

OrbisDB consists of two main components - core and plugins.

- Core:
- Dedicated to read/write operation of the indexing service
- Listens to stream changes of specific models being used by developers and indexes the content in a Postgres database.

- Plugins:
- Optional and designed to perform operations beyond the core’s scope.
- Divided into 4 categories (Create streams, Add metadata, Validate and Post process). More details about plugins underneath.


Head to [OrbisDB Github repository](https://github.com/OrbisWeb3/orbisdb) to start building using OrbisDB.


4 changes: 4 additions & 0 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,10 @@ const config: Config = {
label: "Developer Tools",

items: [
{
to: "docs/orbisdb/overview",
label: "OrbisDB"
},
{
to: "docs/composedb/getting-started",
label: "ComposeDB"
Expand Down
17 changes: 16 additions & 1 deletion sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const sidebars: SidebarsConfig = {
},
items: [
{ type: "doc", id: "introduction/protocol-overview", label: "Ceramic Protocol" },
{ type: "doc", id: "introduction/orbisdb-overview", label: "OrbisDB" },
{ type: "doc", id: "introduction/composedb-overview", label: "ComposeDB" },
{ type: "doc", id: "introduction/did-overview", label: "Decentralized Identifiers" }
]
Expand Down Expand Up @@ -462,7 +463,21 @@ const sidebars: SidebarsConfig = {
id: "ecosystem/community",
label: "Overview"
}
]
],
orbisdb: [
{
type: "doc",
id: "orbisdb/overview",
label: "OrbisDB Overview"
},
{
type: "doc",
id: "orbisdb/orbisdb-sdk",
label: "OrbisDB SDK"
},

],


// But you can create a sidebar manually
/*
Expand Down
Loading