diff --git a/docs/composedb/create-ceramic-app.mdx b/docs/composedb/create-ceramic-app.mdx index 83dccbfb..d3993ede 100644 --- a/docs/composedb/create-ceramic-app.mdx +++ b/docs/composedb/create-ceramic-app.mdx @@ -89,4 +89,4 @@ bunx create-ceramic-app This command will create a new directory with a basic ComposeDB application (a social app). It will clone the app from [repository](https://github.com/ceramicstudio/ComposeDbExampleApp.git), install all dependencies, launch a local Ceramic node, a local GraphQL server and start the app. -Once you have an opportunity to play with an example app and see how it works, you can start building your own app. For that, you will probably want to have more control over your environment and the code. You can find more information on how to set up your environment in the [Set up your environment](./set-up-your-environment) section. +Once you have an opportunity to play with an example app and see how it works, you can start building your own app. For that, you will probably want to have more control over your environment and the code. You can find more information on how to set up your environment in the [Set up your environment](./set-up-your-environment.mdx) section. diff --git a/docs/composedb/examples/index.mdx b/docs/composedb/examples/index.mdx index 870b3bef..7a6a5286 100644 --- a/docs/composedb/examples/index.mdx +++ b/docs/composedb/examples/index.mdx @@ -1,3 +1,3 @@ # Tutorials and Examples -If you have built an example app from the [**Set up your environment**](./set-up-your-environment) section and now you're looking for more, check out the extensive list of [**Starter Applications and Tutorials**](./examples/tutorials-and-examples) or go deep with the [**Verifiable Credentials**](./examples/verifiable-credentials) guide. +If you have built an example app from the [**Set up your environment**](/docs/composedb/set-up-your-environment.mdx) section and now you're looking for more, check out the extensive list of [**Starter Applications and Tutorials**](./tutorials-and-examples.mdx) or go deep with the [**Verifiable Credentials**](./verifiable-credentials.mdx) guide. diff --git a/docs/composedb/getting-started.mdx b/docs/composedb/getting-started.mdx index 95bb3564..c4738fff 100644 --- a/docs/composedb/getting-started.mdx +++ b/docs/composedb/getting-started.mdx @@ -30,12 +30,12 @@ ComposeDB on Ceramic stores and manages data while delivering fast queries and a ## How to Get Started -- [**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. -- [**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. -- [**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. -- [**Create your composite**](./create-your-composite) - Learn how to create your first composite, a reusable data model that can be used across different applications. -- [**Interact with data**](./interact-with-data) - Learn how to interact with data in ComposeDB, from creating, reading, updating, and deleting data to running complex queries. -- [**Core ComposeDB concepts**](./core-concepts) - Learn about the core concepts of ComposeDB, such as composites, schemas, and queries. +- [**See how it works**](./sandbox.mdx) - Explore the ComposeDB Sandbox, a web-based environment to interact with ComposeDB. Run some queries, interact with data, learn about the core concepts. +- [**Create your first Ceramic app**](./create-ceramic-app.mdx) - As easy as running `npx create-ceramic-app`, run your first local Ceramic app and start diving into code. +- [**Set up your environment**](./set-up-your-environment.mdx) - Learn how to set up your development environment to start building with ComposeDB. Experience the real Ceramic network, either on the testnet or mainnet. +- [**Create your composite**](./create-your-composite.mdx) - Learn how to create your first composite, a reusable data model that can be used across different applications. +- [**Interact with data**](./interact-with-data.mdx) - Learn how to interact with data in ComposeDB, from creating, reading, updating, and deleting data to running complex queries. +- [**Core ComposeDB concepts**](./core-concepts.mdx) - Learn about the core concepts of ComposeDB, such as composites, schemas, and queries. ## Join Ceramic Community πŸ’œ diff --git a/docs/composedb/introduction.mdx b/docs/composedb/introduction.mdx index ecada1d9..47b06b17 100644 --- a/docs/composedb/introduction.mdx +++ b/docs/composedb/introduction.mdx @@ -35,18 +35,18 @@ Thank you for being a ComposeDB pioneer and understanding that great Web3 protoc -### [Get Started β†’](./getting-started) +### [Get Started β†’](./getting-started.mdx) Build a Hello World application and interact from the CLI. -### [ComposeDB Sandbox β†’](/docs/composedb/sandbox) +### [ComposeDB Sandbox β†’](/docs/composedb/sandbox.mdx) Test example queries to ComposeDB directly in your browser. -### [Development Guides β†’](./getting-started) +### [Development Guides β†’](./getting-started.mdx) Learn about data modeling, application set up, and data interactions. -### [Core concepts β†’](./core-concepts) +### [Core concepts β†’](./core-concepts.mdx) Dive deeper into the ComposeDB protocol and its components. ### [Community β†’](../ecosystem/community.mdx) -Connect with the ComposeDB developer community. \ No newline at end of file +Connect with the ComposeDB developer community. diff --git a/docs/composedb/set-up-your-environment.mdx b/docs/composedb/set-up-your-environment.mdx index 3444382c..59f045e1 100644 --- a/docs/composedb/set-up-your-environment.mdx +++ b/docs/composedb/set-up-your-environment.mdx @@ -754,7 +754,7 @@ In this Quickstart guide, you have learned how to get started with ComposeDB. Yo -- [**Create your composite**](./create-your-composite) - Learn how to create your first composite, a reusable data model that can be used across different applications. -- [**Interact with data**](./interact-with-data) - Learn how to interact with data in ComposeDB, from creating, reading, updating, and deleting data to running complex queries. -- [**Core ComposeDB concepts**](./core-concepts) - Learn about the core concepts of ComposeDB, such as composites, schemas, and queries. -- [**Running in the cloud**](./guides/composedb-server/running-in-the-cloud) - Ready to upgrade from a local node to production? Learn how to deploy your app. +- [**Create your composite**](./create-your-composite.mdx) - Learn how to create your first composite, a reusable data model that can be used across different applications. +- [**Interact with data**](./interact-with-data.mdx) - Learn how to interact with data in ComposeDB, from creating, reading, updating, and deleting data to running complex queries. +- [**Core ComposeDB concepts**](./core-concepts.mdx) - Learn about the core concepts of ComposeDB, such as composites, schemas, and queries. +- [**Running in the cloud**](./guides/composedb-server/running-in-the-cloud.mdx) - Ready to upgrade from a local node to production? Learn how to deploy your app. diff --git a/docs/ecosystem/community.mdx b/docs/ecosystem/community.mdx index 3e005e50..4307b9b7 100644 --- a/docs/ecosystem/community.mdx +++ b/docs/ecosystem/community.mdx @@ -25,7 +25,7 @@ If you’re interested in a grant feel free to reach out in the #bounties channe - **Marketplace GUI:** Wouldn’t it be great if developers could access the composite marketplace with an app UI instead of a terminal? - **Sample Apps & Models:** Inspire other developers by building sample apps & data models, like reputation credentials, social apps, or DAO tools. - **Easy Node Setup:** Make it easy to deploy ComposeDB on a node - we wrote a [proof of concept](https://github.com/ceramicstudio/ceramic-infra-poc) you can build on. Bonus: Terraform templates for cloud providers like AWS, GCP, and DigitalOcean. -- **Config Script:** We’d love to make [Set up your environment](../composedb/set-up-your-environment) even easier. Want to create a lightning fast script? +- **Config Script:** We’d love to make [Set up your environment](../composedb/set-up-your-environment.mdx) even easier. Want to create a lightning fast script? ### **Open source contributions** Contribute to the [ComposeDB repository](https://github.com/ceramicstudio/js-composedb): here are some packages to get started diff --git a/docs/introduction/composedb-overview.md b/docs/introduction/composedb-overview.md index b9a92798..efbb7c2f 100644 --- a/docs/introduction/composedb-overview.md +++ b/docs/introduction/composedb-overview.md @@ -35,18 +35,18 @@ Thank you for being a ComposeDB pioneer and understanding that great Web3 protoc --- -### [Get Started β†’](../composedb/getting-started) +### [Get Started β†’](../composedb/getting-started.mdx) Build a Hello World application and interact from the CLI. -### [ComposeDB Sandbox β†’](/docs/composedb/sandbox) +### [ComposeDB Sandbox β†’](/docs/composedb/sandbox.mdx) Test example queries to ComposeDB directly in your browser. -### [Development Guides β†’](../composedb/guides) +### [Development Guides β†’](../composedb/guides/index.mdx) Learn about data modeling, application set up, and data interactions. -### [Core concepts β†’](../composedb/core-concepts) +### [Core concepts β†’](../composedb/core-concepts.mdx) Dive deeper into the ComposeDB protocol and its components. -### [Community β†’](../ecosystem/community) -Connect with the ComposeDB developer community. \ No newline at end of file +### [Community β†’](../ecosystem/community.mdx) +Connect with the ComposeDB developer community. diff --git a/docs/introduction/protocol-overview.md b/docs/introduction/protocol-overview.md index 8ffcbb85..382c8c59 100644 --- a/docs/introduction/protocol-overview.md +++ b/docs/introduction/protocol-overview.md @@ -10,7 +10,7 @@ Ceramic is a decentralized event streaming protocol that enables developers to b The Ceramic protocol consists of the following components: -- [**Streams β†’**](../protocol/js-ceramic/streams/streams-index) +- [**Streams β†’**](../protocol/js-ceramic/streams/streams-index.md) - [**Accounts β†’**](../protocol/js-ceramic/accounts/accounts-index.md) - [**Networking β†’**](../protocol/js-ceramic/networking/networking-index.md) - [**Ceramic API β†’**](../protocol/js-ceramic/api.md) @@ -23,22 +23,22 @@ The Ceramic protocol consists of the following components: | Section | State | | --- | --- | -| [1. Streams](../protocol/js-ceramic/streams/streams-index) | **[Draft/WIP](../protocol/js-ceramic/streams/streams-index)** | -| [1.1. Event Log](../protocol/js-ceramic/streams/event-log) | **[Reliable](../protocol/js-ceramic/streams/event-log)** | -| [1.2. URI Scheme](../protocol/js-ceramic/streams/uri-scheme) | **[Reliable](../protocol/js-ceramic/streams/uri-scheme)** | -| [1.3. Consensus](../protocol/js-ceramic/streams/consensus) | **[Draft/WIP](../protocol/js-ceramic/streams/consensus)** | -| [1.4. Lifecycle](../protocol/js-ceramic/streams/lifecycle) | **[Reliable](../protocol/js-ceramic/streams/lifecycle)** | -| [2. Accounts](../protocol/js-ceramic/accounts/accounts-index) | **[Draft/WIP](../protocol/js-ceramic/accounts/accounts-index)** | -| [2.1. Decentralized Identifiers](../protocol/js-ceramic/accounts/decentralized-identifiers) | **[Draft/WIP](../protocol/js-ceramic/accounts/decentralized-identifiers)** | -| [2.2. Authorizations](../protocol/js-ceramic/accounts/authorizations) | **[Reliable](../protocol/js-ceramic/accounts/authorizations)** | -| [2.3. Object-Capabilities](../protocol/js-ceramic/accounts/object-capabilities) | **[Draft/WIP](../protocol/js-ceramic/accounts/object-capabilities)** | -| [3. Networking](../protocol/js-ceramic/networking/networking-index) | **[Draft/WIP](../protocol/js-ceramic/networking/networking-index)** | -| [3.1. Tip Gossip](../protocol/js-ceramic/networking/tip-gossip) | **[Reliable](../protocol/js-ceramic/networking/tip-gossip)** | -| [3.2. Tip Queries](../protocol/js-ceramic/networking/tip-queries) | **[Reliable](../protocol/js-ceramic/networking/tip-queries)** | -| [3.3. Event Fetching](../protocol/js-ceramic/networking/event-fetching) | **[Reliable](../protocol/js-ceramic/networking/event-fetching)** | -| [3.4. Network Identifiers](../protocol/js-ceramic/networking/networks) | **[Reliable](../protocol/js-ceramic/networking/networks)** | -| [4. API](../protocol/js-ceramic/api) | **[Missing](../protocol/js-ceramic/api)** | -| [5. Nodes](../protocol/js-ceramic/nodes/overview) | **[Draft/WIP](../protocol/js-ceramic/nodes/overview)** | +| [1. Streams](../protocol/js-ceramic/streams/streams-index.md) | **[Draft/WIP](../protocol/js-ceramic/streams/streams-index.md)** | +| [1.1. Event Log](../protocol/js-ceramic/streams/event-log.md) | **[Reliable](../protocol/js-ceramic/streams/event-log.md)** | +| [1.2. URI Scheme](../protocol/js-ceramic/streams/uri-scheme.md) | **[Reliable](../protocol/js-ceramic/streams/uri-scheme.md)** | +| [1.3. Consensus](../protocol/js-ceramic/streams/consensus.md) | **[Draft/WIP](../protocol/js-ceramic/streams/consensus.md)** | +| [1.4. Lifecycle](../protocol/js-ceramic/streams/lifecycle.md) | **[Reliable](../protocol/js-ceramic/streams/lifecycle.md)** | +| [2. Accounts](../protocol/js-ceramic/accounts/accounts-index.md) | **[Draft/WIP](../protocol/js-ceramic/accounts/accounts-index.md)** | +| [2.1. Decentralized Identifiers](../protocol/js-ceramic/accounts/decentralized-identifiers.md) | **[Draft/WIP](../protocol/js-ceramic/accounts/decentralized-identifiers.md)** | +| [2.2. Authorizations](../protocol/js-ceramic/accounts/authorizations.md) | **[Reliable](../protocol/js-ceramic/accounts/authorizations.md)** | +| [2.3. Object-Capabilities](../protocol/js-ceramic/accounts/object-capabilities.md) | **[Draft/WIP](../protocol/js-ceramic/accounts/object-capabilities.md)** | +| [3. Networking](../protocol/js-ceramic/networking/networking-index.md) | **[Draft/WIP](../protocol/js-ceramic/networking/networking-index.md)** | +| [3.1. Tip Gossip](../protocol/js-ceramic/networking/tip-gossip.md) | **[Reliable](../protocol/js-ceramic/networking/tip-gossip.md)** | +| [3.2. Tip Queries](../protocol/js-ceramic/networking/tip-queries.md) | **[Reliable](../protocol/js-ceramic/networking/tip-queries.md)** | +| [3.3. Event Fetching](../protocol/js-ceramic/networking/event-fetching.md) | **[Reliable](../protocol/js-ceramic/networking/event-fetching.md)** | +| [3.4. Network Identifiers](../protocol/js-ceramic/networking/networks.md) | **[Reliable](../protocol/js-ceramic/networking/networks.md)** | +| [4. API](../protocol/js-ceramic/api.md) | **[Missing](../protocol/js-ceramic/api.md)** | +| [5. Nodes](../protocol/js-ceramic/nodes/overview.md) | **[Draft/WIP](../protocol/js-ceramic/nodes/overview.md)** | #### **Legend** diff --git a/docs/wheel/wheel-reference.mdx b/docs/wheel/wheel-reference.mdx index f3c7c4cc..ceb6f2ec 100644 --- a/docs/wheel/wheel-reference.mdx +++ b/docs/wheel/wheel-reference.mdx @@ -30,7 +30,7 @@ the following options: housekeeping reasons. - `Mainnet` - for projects in the production stage. This option will require you to do more advanced configurations for your working environment. Generally, this option is only recommended for generating a production configuration file to be - used with a production deployment like [Kubernetes](../composedb/guides/composedb-server/running-in-the-cloud). + used with a production deployment like [Kubernetes](../composedb/guides/composedb-server/running-in-the-cloud.mdx). ### Project Name @@ -79,7 +79,7 @@ use the default suggestion (recommended in most of the cases) or specify a custo ### CAS Authentication -In order to control the nodes connected to CAS (Ceramic Anchor Service), you will have to [configure the authentication](../composedb/guides/composedb-server/access-mainnet). +In order to control the nodes connected to CAS (Ceramic Anchor Service), you will have to [configure the authentication](../composedb/guides/composedb-server/access-mainnet.mdx). This will allow you to set or revoke DIDs for your nodes. You can choose from the following options: - Email Based Authentication - an email authentication method. You will be asked to provide an email that will be used to provide you with an OTP code (a passcode) needed for the authentication.