From 1621bc35ae118e13bb2e31ed3a877c30080f2432 Mon Sep 17 00:00:00 2001 From: Rick Staa Date: Thu, 19 Sep 2024 13:42:16 +0200 Subject: [PATCH 1/2] ci: add broken link check This commit adds a broken link check action. --- .github/workflows/broken-links.yml | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 .github/workflows/broken-links.yml diff --git a/.github/workflows/broken-links.yml b/.github/workflows/broken-links.yml new file mode 100644 index 00000000..8f11a94e --- /dev/null +++ b/.github/workflows/broken-links.yml @@ -0,0 +1,25 @@ +name: Check Broken Links + +on: + pull_request: + branches: + - main + +jobs: + broken-links: + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + - name: Set up Node.js + uses: actions/setup-node@v2 + with: + node-version: '22' + + - name: Install Mintlify globally + run: npm install -g mintlify + + - name: Run broken-links check + run: npx mintlify broken-links From da3101b6f7a8a7c94c93eded406c57fc33c976be Mon Sep 17 00:00:00 2001 From: Rick Staa Date: Thu, 19 Sep 2024 13:42:41 +0200 Subject: [PATCH 2/2] refactor(ai): fix broken links This commit fixes several broken links in the AI documentation. --- ai/contributors/developers.mdx | 4 ++-- ai/contributors/get-started.mdx | 4 ++-- ai/contributors/guides/add-model.mdx | 2 +- ai/contributors/guides/add-pipeline.mdx | 2 +- ai/gateways/start-gateway.mdx | 2 +- ai/orchestrators/onchain.mdx | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/ai/contributors/developers.mdx b/ai/contributors/developers.mdx index eb4e05ac..9193221f 100644 --- a/ai/contributors/developers.mdx +++ b/ai/contributors/developers.mdx @@ -25,7 +25,7 @@ steps to get started: title="Add a new Model" icon="robot" iconType="duotone" - href="/ai/guides/add-model" + href="/ai/contributors/guides/add-model" > Add support for a new diffusion model. @@ -33,7 +33,7 @@ steps to get started: title="Add a new Pipeline" icon="wand-magic-sparkles" iconType="duotone" - href="/ai/guides/add-pipeline" + href="/ai/contributors/guides/add-pipeline" > Add a new pipeline to the AI Subnet. diff --git a/ai/contributors/get-started.mdx b/ai/contributors/get-started.mdx index 26c4a6c2..872caa3c 100644 --- a/ai/contributors/get-started.mdx +++ b/ai/contributors/get-started.mdx @@ -12,13 +12,13 @@ ecosystem together ❤️. Here are a few ways to get started: [Orchestrator Setup Guide](/ai/orchestrators/get-started) page to learn more. - **Gateways**: Server hardware can be used to connect customers to the AI Subnet by setting up an AI Gateway node. Check out the - [Set up AI Gateway](/ai/gateways/setup-gateway) page to learn more. + [Set up AI Gateway](/ai/gateways/get-started) page to learn more. - **Founder**: Founders can contribute by building AI applications on the AI Subnet. Check out the [Build on the AI Subnet](/ai/builders) page to learn more. - **Developers**: Open Source Developers can contribute by improving the AI Subnet codebase. Check out the guide on - [Contributing to the AI Subnet](/ai/contribute-to-ai-subnet) to learn more. + [Contributing to the AI Subnet](/ai/contributors/coming-soon) to learn more. For any questions or help needed, reach out in the `ai-video` channel of the [Livepeer Discord](https://discord.gg/7w2R6v). Support is available to help get diff --git a/ai/contributors/guides/add-model.mdx b/ai/contributors/guides/add-model.mdx index 6e39a32b..551fb8e5 100644 --- a/ai/contributors/guides/add-model.mdx +++ b/ai/contributors/guides/add-model.mdx @@ -24,7 +24,7 @@ through the steps to add a new model to the AI Subnet. ## Step-by-Step Guide Adding a new model to the AI Subnet is relatively straightforward since each -supported [pipeline](/ai/guides/add-pipeline) is designed to support multiple +supported [pipeline](/ai/contributors/guides/add-pipeline) is designed to support multiple diffusion models in the respective diffusion pipeline. To add a new model, you will need to follow these steps: diff --git a/ai/contributors/guides/add-pipeline.mdx b/ai/contributors/guides/add-pipeline.mdx index 61b70fbb..fd52d860 100644 --- a/ai/contributors/guides/add-pipeline.mdx +++ b/ai/contributors/guides/add-pipeline.mdx @@ -25,7 +25,7 @@ through the steps to add a new pipeline to the AI Subnet. ## Step-by-Step Guide Adding a new pipeline to the AI Subnet is more involved than -[adding a new model](ai/contribute/guides), but it is still relatively +[adding a new model](/ai/contributors/guides/add-model), but it is still relatively straightforward. To add a new pipeline, you will need to follow these steps: 1. **Fork the AI Worker Repository**: Fork the [Livepeer AI Worker]() repository diff --git a/ai/gateways/start-gateway.mdx b/ai/gateways/start-gateway.mdx index 4d180932..2a55c2b0 100644 --- a/ai/gateways/start-gateway.mdx +++ b/ai/gateways/start-gateway.mdx @@ -105,7 +105,7 @@ Follow the steps below to start your Livepeer AI Gateway node: - If binaries are unavailable for your system, you can build the [ai-video branch](https://github.com/livepeer/go-livepeer/tree/ai-video) of [go-livepeer](https://github.com/livepeer/go-livepeer) from source. Refer to the [Livepeer installation guide](/gateways/guides/install-go-livepeer) or reach out to the Livepeer community on [Discord](https://discord.gg/livepeer) for assistance. + If binaries are unavailable for your system, you can build the [ai-video branch](https://github.com/livepeer/go-livepeer/tree/ai-video) of [go-livepeer](https://github.com/livepeer/go-livepeer) from source. Refer to the [Livepeer installation guide](/orchestrators/guides/install-go-livepeer#install-using-a-binary-release) or reach out to the Livepeer community on [Discord](https://discord.gg/livepeer) for assistance. diff --git a/ai/orchestrators/onchain.mdx b/ai/orchestrators/onchain.mdx index e87b8dfa..189aeb42 100644 --- a/ai/orchestrators/onchain.mdx +++ b/ai/orchestrators/onchain.mdx @@ -32,7 +32,7 @@ your AI Orchestrator node to redeem tickets: For security, it's advised to use a separate account from your **Mainnet Transcoding Network Orchestrator**. - Create a new Ethereum wallet for your **AI Orchestrator**. Follow the [Create a Wallet](/catalyst/deploying-catalyst#creating-a-wallet) guide in the [Catalyst](/catalyst/deploying-catalyst) documentation for detailed instructions. + Create a new Ethereum wallet for your **AI Orchestrator**. Follow the [Create a Wallet](/self-hosting/deploying#creating-a-wallet) guide in the [Catalyst](/self-hosting/deploying) documentation for detailed instructions. Transfer sufficient ETH to the new wallet to cover the gas costs for redeeming AI tickets on-chain.