staging updates

ceramicnetwork · Sep 6, 2024 · fdc2d9b · fdc2d9b
1 parent 15c7637
commit fdc2d9b
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 15 deletions.
diff --git a/docs/composedb/create-ceramic-app.mdx b/docs/composedb/create-ceramic-app.mdx
@@ -5,12 +5,43 @@ import TabItem from "@theme/TabItem";
 
 Get up and running quickly with a basic ComposeDB application with one command.
 
+---
+
 **Prerequisites**
 
 - Operating system: **Linux, Mac, or Windows** (only [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install))
 - **Node.js v20** - If you are using a different version, please use `nvm` to install Node.js v20 for best results.
 - **npm v10** - Installed automatically with NodeJS v20
 
+You will also need to run a ceramic-one node in the background which provides Ceramic 
+data network access. To set it up, follow the steps below:
+
+:::note
+The instructions below cover the steps for the MacOS-based systems. If you are running on a Linux-based system, you can find the 
+instructions [here](https://github.com/ceramicnetwork/rust-ceramic?tab=readme-ov-file#linux---debian-based-distributions).
+:::
+
+1. Install the component using [Homebrew](https://brew.sh/):
+
+```bash
+brew install ceramicnetwork/tap/ceramic-one
+```
+
+2. Start the `ceramic-one` using the following command:
+```bash
+ceramic-one daemon --network in-memory
+```
+
+:::note
+By default, the command above will spin off a node which connects to a `in-memory`. You can change this behaviour by providing a `--network` flag and specifying a network of your choice. For example:
+
+```ceramic-one daemon --network testnet-clay```
+:::
+
+---
+
+## Start the ComposeDB example app
+
 You can easily create a simple ComposeDB starter project by using our CLI and running the following command:
 
 <Tabs

diff --git a/docs/introduction/composedb-overview.md b/docs/introduction/composedb-overview.md
@@ -25,16 +25,13 @@ ComposeDB is a composable graph database built on [Ceramic](https://ceramic.netw
 
 ### Project Status: `Beta`
 
-ComposeDB officially entered `Beta` on February 28, 2023. What does this mean?
+Currently, ComposeDB is in `Beta`. What does this mean?
 
 - You can now build and deploy apps to production on mainnet! 
 - Core features like GraphQL APIs, reusable models, and data composability are available
 - We will continue to improve performance and add more features
 - We are not yet guaranteeing a 100% stable, bug-free platform
 
-If you want to provide feedback, request new features, or report insufficient performance, please [make a post on the Forum](https://forum.ceramic.network/), as we'd like to work with you.
-Thank you for being a ComposeDB pioneer and understanding that great Web3 protocols take time to mature.
-
 ---
 
 

diff --git a/docs/introduction/orbisdb-overview.md b/docs/introduction/orbisdb-overview.md
@@ -2,13 +2,13 @@
 
 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).
+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 other existing database products like [ComposeDB](./composedb-overview).
 
 <div align="center"><iframe width="660" height="415" src="https://www.youtube.com/embed/gxHphFzkV3k" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe></div>
 
 
-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. 
+OrbisDB comes with with a shared instance called [Orbis Studio](https://studio.useorbis.com/), 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!
+Learn more about OrbisDB and start building today!
 
 
diff --git a/docs/orbisdb/orbisdb-sdk.md b/docs/orbisdb/orbisdb-sdk.md
@@ -4,5 +4,5 @@ OrbisDB comes with an [OrbisDB SDK](https://github.com/OrbisWeb3/db-sdk) which m
 
 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.
+Head to the [Orbis documentation](https://github.com/OrbisWeb3/db-sdk) to learn more and start interacting with OrbisDB SDK.
 
diff --git a/docs/orbisdb/overview.md b/docs/orbisdb/overview.md
@@ -4,7 +4,7 @@
 
 ### 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).
+OrbisDB comes with an easy-to-use shared instance called [Orbis Studio](https://studio.useorbis.com/) 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.
 
 
 

diff --git a/src/components/homepage/get-started.js b/src/components/homepage/get-started.js
@@ -13,7 +13,7 @@ const FeatureList = [
     ]
   },
   {
-    title: "ComposeDB Sandbox →",
+    title: "Sandbox →",
     items: [
       {
         url: "docs/composedb/sandbox",

diff --git a/src/components/homepage/start-building.js b/src/components/homepage/start-building.js
@@ -22,9 +22,9 @@ const FeatureList = [
     ]
   },
   {
-    title: "ComposeDB →",
+    title: "Interact with Event Store SDK →",
     items: [
-      { url: "docs/composedb/getting-started", text: "Build composable dApps using a decentralised graph database." }
+      { url: "docs/composedb/getting-started", text: "Interact with Event Store's primitive APIs" }
     ]
   }
 ];

diff --git a/src/pages/index.js b/src/pages/index.js
@@ -65,9 +65,9 @@ export default function Home() {
                 background: "linear-gradient(215deg, #660094 -33%, var(--box-color) 50%)"
               }}
             >
-              <h3>Build with ComposeDB</h3>
+              <h3>Run nodes and explore the Ceramic protocol specificiation</h3>
               <div>
-                A decentralized, composable graph database to build interoperable applications on Ceramic.
+                Ceramic protocol specifications and APIs for creting streams, producting and cosuming events from streans and aggregating the stream state.
               </div>
               <div
                 style={{
@@ -81,7 +81,7 @@ export default function Home() {
                 }}
               >
                 <div>
-                  <a href="/docs/composedb/getting-started">Getting Started → </a>
+                  <a href="/docs/protocol/js-ceramic/overview">Getting Started → </a>
                 </div>
               </div>
             </div>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,5 +4,5 @@ OrbisDB comes with an [OrbisDB SDK](https://github.com/OrbisWeb3/db-sdk) which m

		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.
		Head to the [Orbis documentation](https://github.com/OrbisWeb3/db-sdk) to learn more and start interacting with OrbisDB SDK.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,7 +4,7 @@

		### 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).
		OrbisDB comes with an easy-to-use shared instance called [Orbis Studio](https://studio.useorbis.com/) 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.



Expand Down