Skip to content

Commit

Permalink
ci: add broken links action (#653)
Browse files Browse the repository at this point in the history
* ci: add broken link check

This commit adds a broken link check action.

* refactor(ai): fix broken links

This commit fixes several broken links in the AI documentation.
  • Loading branch information
rickstaa authored Sep 19, 2024
1 parent be1a841 commit 56678c1
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 8 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/broken-links.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 2 additions & 2 deletions ai/contributors/developers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ 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.
</Card>
<Card
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.
</Card>
Expand Down
4 changes: 2 additions & 2 deletions ai/contributors/get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ai/contributors/guides/add-model.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion ai/contributors/guides/add-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ai/gateways/start-gateway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Follow the steps below to start your Livepeer AI Gateway node:
</Steps>

<Note>
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.
</Note>
</Tab>

Expand Down
2 changes: 1 addition & 1 deletion ai/orchestrators/onchain.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ your AI Orchestrator node to redeem tickets:
<Step title="Wallet Creation">
<Info>For security, it's advised to use a separate account from your **Mainnet Transcoding Network Orchestrator**.</Info>

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.
</Step>
<Step title="Wallet Funding">
Transfer sufficient ETH to the new wallet to cover the gas costs for redeeming AI tickets on-chain.
Expand Down

0 comments on commit 56678c1

Please sign in to comment.