Skip to content

Commit 233cda2

Browse files
smrz2001dtbuchholzstbrody
authored
feat: ceramic-one docs (#112)
* feat: add ceramic one, orbis db updates * feat: ceramic-one docs * fix: update produce.mdx as per latest sdk * more c1 updates * remove advanced usage * review comment Co-authored-by: Spencer T Brody <[email protected]> * remove all 3rd party tooling * ci updates * ci updates * ci updates * ci updates * fix broken links --------- Co-authored-by: Dan Buchholz <[email protected]> Co-authored-by: Spencer T Brody <[email protected]>
1 parent 0a92347 commit 233cda2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+19639
-40802
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Build and deploy docs
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
push:
8+
branches:
9+
- main
10+
workflow_dispatch: # manually triggered
11+
12+
jobs:
13+
build:
14+
name: Build docs website
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: Checkout repository
18+
uses: actions/checkout@v4
19+
20+
- name: Install pnpm
21+
uses: pnpm/action-setup@v4
22+
with:
23+
version: 10
24+
run_install: |
25+
- args: [--frozen-lockfile]
26+
27+
- name: Setup node
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 22
31+
cache: 'pnpm'
32+
33+
- name: Build docs website
34+
run: pnpm build
35+
36+
- name: Deploy to GitHub Pages
37+
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
38+
uses: peaceiris/actions-gh-pages@v4
39+
with:
40+
github_token: ${{ secrets.GITHUB_TOKEN }}
41+
publish_dir: ./build
42+
user_name: github-actions[bot]
43+
user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/build-docs.yml

Lines changed: 0 additions & 45 deletions
This file was deleted.

.github/workflows/deploy-docs.yml

Lines changed: 0 additions & 54 deletions
This file was deleted.

docs/composedb/core-concepts.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ type Posts @createModel(accountRelation: LIST, description: "A simple Post") {
5858

5959
#### Account to Model Relations
6060

61-
Any document can always be queried by its author's account using the required `accountRelation` property. See [Account to Model Relations](./guides/data-modeling/relations.mdx#account-to-model-relations) for more.
61+
Any document can always be queried by its author's account using the required `accountRelation` property. See [Account to Model Relations](./guides/data-modeling/relations.mdx#account-to-model) for more.
6262

6363
##### Model
6464

@@ -85,7 +85,7 @@ Let's query the `DisplayName` using the author's account:
8585

8686
#### Model to Account Relations
8787

88-
Enable a document to be queried by a referenced account using the `@accountReference` directive. See [Model to Account Relations](./guides/data-modeling/relations.mdx#model-to-account-relations) for more.
88+
Enable a document to be queried by a referenced account using the `@accountReference` directive. See [Model to Account Relations](./guides/data-modeling/relations.mdx#model-to-account) for more.
8989

9090
##### Model
9191

@@ -113,7 +113,7 @@ Let's query messages based on recipient using `@accountReference`:
113113

114114
#### Model to Model Relations
115115

116-
Enable a document to be queried by its relationship to other documents using the `@documentReference` and `@relationFrom` directives. See [Model to Model Relations](./guides/data-modeling/relations.mdx#model-to-model-relations) for more.
116+
Enable a document to be queried by its relationship to other documents using the `@documentReference` and `@relationFrom` directives. See [Model to Model Relations](./guides/data-modeling/relations.mdx#model-to-model) for more.
117117

118118
##### Model
119119

docs/composedb/examples/tutorials-and-examples.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Looking for code samples, starter applications, and tutorials to kickstart your
44

55
## Starter Applications
66

7-
- [**Official ComposeDB Example App**](https://github.com/ceramicstudio/ComposeDbExampleApp) - A starter application built around a social media platform use-case (this application utilizes the same data models used by the [ComposeDB Sandbox](/docs/composedb/sandbox)). A great first step if you haven't done anything with ComposeDB yet.
7+
- [**Official ComposeDB Example App**](https://github.com/ceramicstudio/ComposeDbExampleApp) - A starter application built around a social media platform use-case. A great first step if you haven't done anything with ComposeDB yet.
88
- [**Lit Protocol with ComposeDB**](https://github.com/ceramicstudio/lit-composedb) - Encrypt and decrypt data based on on-chain condition logic using Lit Protocol while storing on ComposeDB
99
- [**Ethereum Attestation Service on ComposeDB**](https://github.com/ceramicstudio/ceramic-eas) - Save attestations generated using the Ethereum Attestation Service to the Ceramic Network using ComposeDB.
1010
- [**OpenAI Realtime Chat with ComposeDB**](https://github.com/ceramicstudio/ceramic-ai) - Interact with an OpenAI API endpoint in the form of a realtime chat application with storage on ComposeDB.

docs/composedb/getting-started.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ ComposeDB on Ceramic stores and manages data while delivering fast queries and a
3030

3131
## How to Get Started
3232

33-
- [**See how it works**](./sandbox) - Explore the ComposeDB Sandbox, a web-based environment to interact with ComposeDB. Run some queries, interact with data, learn about the core concepts.
3433
- [**Create your first Ceramic app**](./create-ceramic-app) - As easy as running `npx create-ceramic-app`, run your first local Ceramic app and start diving into code.
3534
- [**Set up your environment**](./set-up-your-environment) - Learn how to set up your development environment to start building with ComposeDB. Experience the real Ceramic network, either on the testnet or mainnet.
3635
- [**Create your composite**](./create-your-composite) - Learn how to create your first composite, a reusable data model that can be used across different applications.

docs/composedb/guides/composedb-server/running-in-the-cloud.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,7 @@ docker run -d \
323323

324324
### Editing the `daemon.config.json` file
325325

326-
To have the settings persist in your Ceramic node, edit the `daemon.config.json` file to include the configurations. The default location is `~/.ceramic/daemon.config.json`. For a full file example, see the [Ceramic](../../../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#example-daemonconfigjson) docs.
326+
To have the settings persist in your Ceramic node, edit the `daemon.config.json` file to include the configurations. The default location is `~/.ceramic/daemon.config.json`. For a full file example, see the [Ceramic](./server-configurations#default-configurations) docs.
327327

328328
```bash
329329
...

docs/composedb/guides/composedb-server/server-configurations.mdx

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,16 +192,14 @@ Only Postgres is currently supported for production usage.
192192
| remote | IPFS running in separate compute process; recommended for production and everything besides early prototyping ||
193193

194194
### Persistent Storage
195-
To run a Ceramic node in production, it is critical to persist the [Ceramic state store](../../../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#ceramic-state-store) and the [IPFS datastore](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#datastorespec). The form of storage you choose should also be configured for disaster recovery with data redundancy, and some form of snapshotting and/or backups.
195+
To run a Ceramic node in production, it is critical to persist the [Ceramic state store](#ceramic-state-store) and the [IPFS datastore](https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#datastorespec). The form of storage you choose should also be configured for disaster recovery with data redundancy, and some form of snapshotting and/or backups.
196196

197197
**Loss of this data can result in permanent loss of Ceramic streams and will cause your node to be in a corrupt state.**
198198

199199
The Ceramic state store and IPFS datastore are stored on your machine's filesystem by default. The Ceramic state store defaults to `$HOME/.ceramic/statestore`. The IPFS datastore defaults to `ipfs/blocks` located wherever you run IPFS.
200200

201201
The fastest way to ensure data persistence is by mounting a persistent volume to your instances and configuring the Ceramic and IPFS nodes to write to the mount location. The mounted volume should be configured such that the data persists if the instance shuts down.
202202

203-
You can also use AWS S3 for data storage which is supported for both Ceramic and IPFS. Examples of the configuration are shared on the Ceramic docs [here](../../../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#example-aws-s3-policies).
204-
205203
### IPFS Datastore
206204

207205
The IPFS datastore stores the raw IPFS blocks that make up Ceramic streams. To prevent data corruption, use environment variables written to your profile file, or otherwise injected into your environment on start so that the datastore location does not change between reboots.

docs/composedb/introduction.mdx

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,6 @@ Thank you for being a ComposeDB pioneer and understanding that great Web3 protoc
3838
### [Get Started →](./getting-started)
3939
Build a Hello World application and interact from the CLI.
4040

41-
### [ComposeDB Sandbox →](/docs/composedb/sandbox)
42-
Test example queries to ComposeDB directly in your browser.
43-
4441
### [Development Guides →](./getting-started)
4542
Learn about data modeling, application set up, and data interactions.
4643
<!-- Server Config-->
@@ -49,4 +46,4 @@ Learn about data modeling, application set up, and data interactions.
4946
Dive deeper into the ComposeDB protocol and its components.
5047

5148
### [Community →](../ecosystem/community.mdx)
52-
Connect with the ComposeDB developer community.
49+
Connect with the ComposeDB developer community.

0 commit comments

Comments
 (0)