Skip to content

Commit 774c5af

Browse files
committed
fix broken links
1 parent 1c00f1b commit 774c5af

File tree

9 files changed

+28
-32
lines changed

9 files changed

+28
-32
lines changed

.github/workflows/build-deploy-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ jobs:
3535

3636
- name: Deploy to GitHub Pages
3737
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
38-
uses: peaceiris/actions-gh-pages@v3
38+
uses: peaceiris/actions-gh-pages@v4
3939
with:
4040
github_token: ${{ secrets.GITHUB_TOKEN }}
4141
publish_dir: ./build

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/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/set-up-your-environment.mdx

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ By the end of this guide you'll have a good understanding of how to get started
1717

1818
There are a few ways to set up your environment. Choose the one that best fits your needs:
1919

20-
- [Using `create-ceramic-app`](#installation-using-create-ceramic-app) - get up and running quickly with a basic ComposeDB application with one command. Good for the first quick experience with Ceramic and ComposeDB.
21-
- [Using the Wheel](#installation-using-wheel) - the recommended and the easiest way to configure your full working environment and install the necessary dependencies.
22-
- [Using JavaScript package managers](#installation-using-javascript-package-managers) - an alternative, more manual, way to configure your working environment which supports `npm`, `pnpm` and `yarn`.
20+
- [Using `create-ceramic-app`](#2a-installation-using-create-ceramic-app) - get up and running quickly with a basic ComposeDB application with one command. Good for the first quick experience with Ceramic and ComposeDB.
21+
- [Using the Wheel](#2b-installation-using-wheel) - the recommended and the easiest way to configure your full working environment and install the necessary dependencies.
22+
- [Using JavaScript package managers](#2c-installation-using-javascript-package-managers) - an alternative, more manual, way to configure your working environment which supports `npm`, `pnpm` and `yarn`.
2323

24-
**Install and start the `ceramic-one` binary**
24+
##### Install and start the `ceramic-one` binary
2525

2626
All of the configuration options listed above **require a `ceramic-one` binary up and running**, which provides a data network access. You can run `ceramic-one` on your
2727
local machine using two simple steps listed below.
@@ -145,7 +145,7 @@ The easiest and recommended way to configure your full local development environ
145145

146146
In order to use Wheel, you’ll have to install a few dependencies:
147147

148-
**Node.js**
148+
##### Node.js
149149

150150
If you don’t already have them installed, you will need to install at least:
151151

@@ -159,12 +159,12 @@ node -v
159159
npm -v
160160
```
161161

162-
**jq**
162+
##### jq
163163

164164
`jq` is a lightweight and flexible command-line JSON processor. The installation method depends on your operating system. Install it using one of the methods defined in
165165
the [official tutorial here](https://stedolan.github.io/jq/download/).
166166

167-
**PostgreSQL** (optional)
167+
##### PostgreSQL (optional)
168168

169169
PostgreSQL is only required for a production configuration on the Mainnet. If you are new to ComposeDB on Ceramic and would like to quickly test it out, you can skip the PostgreSQL installation and come back to it once you are ready to scale your project. You will need Postgres installed on your machine to store indexed data.
170170

@@ -311,7 +311,7 @@ Check out [this video tutorial](https://www.youtube.com/watch?v=r68FXBTCBZ4) for
311311
</table>
312312
313313
Another way to install the dependencies and configure Ceramic is using JavaScript package managers. This option requires more manual steps. The guide below covers this
314-
process step-by-step. If you have followed the [Wheel installation](#installation-using-wheel) guide above, you can skip this section.
314+
process step-by-step. If you have followed the [Wheel installation](#2b-installation-using-wheel) guide above, you can skip this section.
315315
316316
#### Install the dependencies
317317
@@ -322,7 +322,7 @@ mkdir my-project #creates a new directory
322322
cd my-project #targets the created directory
323323
```
324324

325-
**Node.js**
325+
##### Node.js
326326

327327
If you don’t already have them installed, you will need to install Node.js v20 and a package manager. We primarily use `pnpm`, but `npm` and `yarn` are supported as well.
328328

@@ -336,11 +336,11 @@ node -v
336336
pnpm -v
337337
```
338338

339-
**ceramic-one**
339+
##### ceramic-one
340340

341341
Make sure you have the `ceramic-one` binary up and running. To do that, follow the steps listed [here](#2-installation).
342342

343-
**Ceramic**
343+
##### Ceramic
344344

345345
ComposeDB runs on Ceramic, so you will need to run a Ceramic node. To get started, we recommend running a local Ceramic node. If you're interested in running the production node, you can follow one of the [guides here](./guides/composedb-server/).
346346

@@ -383,7 +383,7 @@ yarn global add @ceramicnetwork/cli
383383
</TabItem>
384384
</Tabs>
385385

386-
**ComposeDB**
386+
##### ComposeDB
387387

388388
Next install the ComposeDB CLI, which enables you to interact with ComposeDB data from your terminal:
389389

@@ -476,7 +476,7 @@ yarn add -D @composedb/devtools@^0.5.0 @composedb/devtools-node@^0.5.0
476476

477477
All dependencies are installed. Now you can start setting up your project. The first step is to run a local Ceramic node.
478478

479-
**Run a Ceramic node**
479+
##### Run a Ceramic node
480480

481481
You can check that everything was installed correctly by spinning up a Ceramic node. Running the command below will start the Ceramic node in local mode and connect to Clay testnet.
482482
Indexing is a key component of ComposeDB, which syncs data across nodes. Enable indexing by toggling:
@@ -523,7 +523,7 @@ IMPORTANT: Ceramic API running on 0.0.0.0:7007
523523
Now, that you have installed everything successfully and are able to run the node, let's create a developer account. You can stop
524524
the node for now by using the keyboard combination `Control+C`.
525525

526-
**Generate your private key**
526+
##### Generate your private key
527527

528528
You will need a private key for authorizing ComposeDB CLI commands in the later stages of development. You can generate it using the command below:
529529

@@ -546,7 +546,7 @@ Store your private key securely - the key allows changes to be made to your app.
546546

547547
:::
548548

549-
**Generate your account**
549+
##### Generate your account
550550

551551
Indexing is one of the key features of ComposeDB. In order to notify the Ceramic node which models have to be indexed, the ComposeDB tools have to interact with the restricted Admin API. Calling the API requires an authenticated Decentralized Identifier (DID) to be provided in the node configuration file. Create a DID by running the following command, using the private key generated previously instead of the placeholder variable `your-private-key`:
552552

@@ -581,7 +581,7 @@ cd ~/.ceramic
581581
Inside of this directory you should find the following files:
582582

583583
- `daemon.config.json` - your Ceramic node configuration file
584-
- `statestore` - a local directory for [persisting the data](../protocol/js-ceramic/guides/ceramic-nodes/running-cloud#ceramic-state-store)
584+
- `statestore` - a local directory for [persisting the data](./guides/composedb-server/server-configurations#ceramic-state-store)
585585

586586
Open the `daemon.config.json` file using your preferred code editor and provide the authenticated DID, generated in the [generate your account](#generate-your-account) step of this guide, in the `admin-dids` section of the file as shown in the example below:
587587

docs/protocol/ceramic-one/concepts.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ you're interacting with directly.
1818

1919
Events are atomic units of information, captured at a point in time and propagated throughout the
2020
Ceramic network. Events are organized into [streams](#streams), which group related events into a
21-
sequence and provide a [consistent ordering](#consistent-ordering) that all [consumers](#consumers)
22-
can agree upon and validate.
21+
sequence and provide a consistent ordering that all [consumers](#consumers) can agree upon and validate.
2322

2423
Events include a `data` payload, which is a sequence of bytes whose structure and semantics are
2524
determined by applications building on the Ceramic protocol.

docs/protocol/js-ceramic/guides/ceramic-clients/authentication/did-jsonrpc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ One option is installing and setting up one or more account providers that run l
6767

6868
| Account | Supported Key Types | Provider libraries |
6969
| ------- | ------------------- | ---------------------------------------------------------------- |
70-
| Key DID | Ed25519 | [`key-did-provider-ed25519`](./key-did.md#ed25519) |
71-
| Key DID | Secp256k1 | [`key-did-provider-secp256k1`](./key-did.md#secp256k1) |
70+
| Key DID | Ed25519 | [`key-did-provider-ed25519`](./key-did#key-did-provider-ed25519) |
71+
| Key DID | Secp256k1 | [`key-did-provider-secp256k1`](./key-did#key-did-provider-secp256k1) |
7272

7373
<!-- | PKH DID | ????????? | [`js-pkh-did-provider →`]() | -->
7474

@@ -274,4 +274,4 @@ console.log(await did.decryptDagJWE(dagJWE))
274274
---
275275
276276
- To support transactions, you'll need to set up your DID provider for authentication.
277-
-->
277+
-->

docusaurus.config.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,7 @@ const config: Config = {
167167
"/reference/typescript/interfaces/_ceramicnetwork_common.AnchorValidator.html",
168168
"/reference/typescript/DEVELOPMENT.md",
169169
"/reference/typescript/docs-dev/UPGRADING.md",
170-
"/reference/typescript/docs-dev/QUICKSTART.md",
171-
"/reference/typescript/DEVELOPMENT.md"
170+
"/reference/typescript/docs-dev/QUICKSTART.md"
172171
]
173172
},
174173
{

sidebars.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ const sidebars: SidebarsConfig = {
212212
},
213213
{ type: "doc", id: "composedb/create-your-composite", label: "Create your composite" },
214214
{ type: "doc", id: "composedb/interact-with-data", label: "Interact with data" },
215-
{ type: "doc", id: "composedb/core-concepts", label: "Core ComposeDBconcepts" },
215+
{ type: "doc", id: "composedb/core-concepts", label: "Core ComposeDB concepts" },
216216
{ type: "doc", id: "composedb/next-steps", label: "Next Steps" }
217217
]
218218
},

0 commit comments

Comments
 (0)