From 3ef43e4c781a5fa05214be4a0e60ef283478cfa0 Mon Sep 17 00:00:00 2001 From: Avi Atkin <103125634+3avi@users.noreply.github.com> Date: Wed, 8 Feb 2023 16:47:16 -0500 Subject: [PATCH] added composedb to build index (#278) --- .github/workflows/deploy.yml | 2 +- docs/build/index.md | 28 ++++++++++++++++------------ 2 files changed, 17 insertions(+), 13 deletions(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ddfdea707..ce15f1241 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -18,7 +18,7 @@ jobs: with: python-version: 3.x - name: Install MkDocs Material Insiders - run: pip install git+https://${INSIDERS_GITHUB_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git + run: pip install git+https://${INSIDERS_GITHUB_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@910f9e6e93520e511ba3c5098f2654df58ee7748 - name: Install plugins run: pip install mkdocs-minify-plugin mkdocs-redirects - name: Deploy docs diff --git a/docs/build/index.md b/docs/build/index.md index 736fb2751..ac00a159c 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -4,25 +4,19 @@ Ceramic provides a decentralized network for building Web3 applications with composable data. Ceramic's APIs enable applications to store, modify, and retrieve data from a scalable decentralized data network, while maintaining composability of data across applications. -## **System requirements** +## **Get Started** --- -Ceramic clients and tools using them are designed for environments supporting [ECMAScript 11th edition](https://262.ecma-international.org/11.0/), commonly referred to as ES2020. - -Most packages are exposed as ECMAScript Modules (ESM), which are supported by most modern browsers and recent versions of Node. - -When using Node, we recommend version 16 (LTS), as it is the version used for tests in most Ceramic packages. - -## **Get started with frameworks** +### [**ComposeDB →**](https://composedb.js.org/) ---- +ComposeDB is the latest and greatest way to build apps on Ceramic's data layer. It is a decentralized, verifiable graph DB and supports both Javascript and GraphQL. -Frameworks make it easy to build applications on Ceramic by abstracting away much of the complexity and configuration of the underlying [Ceramic stack](the-ceramic-stack.md), providing developers with a simple entrypoint into Ceramic development. If you're new to Ceramic, or even if you're experienced, this is the place to start. +### [**IDX & Self.ID SDK →**](../reference/self-id/index.md) -### [**Self.ID SDK →**](../reference/self-id/index.md) +A legacy alternative to ComposeDB is IDX, a key-value store DB, also built on Ceramic. -Self.ID is a framework for building Ceramic applications with composable, user-centric data. In addition to including a full Ceramic setup for a variety of development environments, Self.ID allows users to authenticate with their existing blockchain wallets and also includes some of the most popular data models giving you out of the box composability with a rich set of data on the network to bootstrap your application. +Self.ID is a framework for building applications for IDX on Ceramic. In addition to including a full Ceramic setup for a variety of development environments, The Self.ID SDK allows users to authenticate with their existing blockchain wallets and also includes some of the most popular data models giving you out of the box composability with a rich set of data on the network to bootstrap your application. ## **Go deeper with clients** @@ -33,3 +27,13 @@ Clients are a lower-level way to connect your application to the Ceramic network ### [**JavaScript HTTP client →**](../reference/core-clients/ceramic-http.md) The Ceramic JS HTTP client is a Ceramic client that can be used in browsers and Node.js environments to connect your application to a Ceramic node. This is the recommended Ceramic client to build with for most applications, if you're not using a framework. + +## **System requirements** + +--- + +Ceramic clients and tools using them are designed for environments supporting [ECMAScript 11th edition](https://262.ecma-international.org/11.0/), commonly referred to as ES2020. + +Most packages are exposed as ECMAScript Modules (ESM), which are supported by most modern browsers and recent versions of Node. + +When using Node, we recommend version 16 (LTS), as it is the version used for tests in most Ceramic packages. \ No newline at end of file