diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index f0d7207..04345c3 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -12,3 +12,18 @@ jobs: - uses: errata-ai/vale-action@reviewdog with: fail_on_error: true + docs-quality: + name: Check docs standards + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + lfs: true + - name: Setup Node + uses: actions/setup-node@v4 + with: + node-version: 20 + - name: Install Mintlify CLI + run: npm install -g mintlify + - name: Run Mintlify broken-links + run: mintlify broken-links diff --git a/api-reference/workflows/creating-task-runner.mdx b/api-reference/workflows/creating-task-runner.mdx index 6c55ad3..2eb6fe6 100644 --- a/api-reference/workflows/creating-task-runner.mdx +++ b/api-reference/workflows/creating-task-runner.mdx @@ -4,7 +4,7 @@ description: How to create a task runner icon: list-check --- -From a [client instance](/workflows/creating) you can create a [TaskRunner](/workflows/concepts/task-runners), capable of executing tasks. +From a client instance you can create a [TaskRunner](/workflows/concepts/task-runners), capable of executing tasks. diff --git a/api-reference/workflows/submitting-job.mdx b/api-reference/workflows/submitting-job.mdx index 1b523de..d834bf4 100644 --- a/api-reference/workflows/submitting-job.mdx +++ b/api-reference/workflows/submitting-job.mdx @@ -4,7 +4,7 @@ description: How to submit a job icon: diagram-project --- -To execute a workflow, you first need to submit a [job](/workflow/jobs) to the Tilebox API. +To execute a workflow, you first need to submit a [job](/workflows/concepts/jobs) to the Tilebox API. This can be done by calling the `submit` method of a `JobClient` instance. diff --git a/api-reference/workflows/task-inputs.mdx b/api-reference/workflows/task-inputs.mdx index 7ca141b..8f05ab9 100644 --- a/api-reference/workflows/task-inputs.mdx +++ b/api-reference/workflows/task-inputs.mdx @@ -4,7 +4,7 @@ description: How to define task inputs icon: laptop-code --- -A task can optionally define [input parameters](/workflow/tasks#input-parameters). +A task can optionally define [input parameters](/workflows/concepts/tasks#input-parameters). These parameters are defined as class attributes, the same way as you would define a dataclass. diff --git a/datasets/introduction.mdx b/datasets/introduction.mdx index e852903..54eb303 100644 --- a/datasets/introduction.mdx +++ b/datasets/introduction.mdx @@ -53,7 +53,7 @@ Here are some terms used throughout this section. Prerequisites -- You've [installed](/sdks/python/installation) the `tilebox-datasets` package +- You've [installed](/sdks/python/install) the `tilebox-datasets` package - You've [created](/authentication) a Tilebox API key With the prerequisites out of the way, you can now create a client instance to start interacting with your Tilebox Datasets. diff --git a/workflows/concepts/clusters.mdx b/workflows/concepts/clusters.mdx index 5ed8766..10293a8 100644 --- a/workflows/concepts/clusters.mdx +++ b/workflows/concepts/clusters.mdx @@ -34,7 +34,7 @@ Before registering a task runner, or submitting a job, you need to create a clus clusters as needed. The following sections illustrates how to do this. To manage clusters, you first need to instantiate a cluster client. You can do this by calling the `clusters` method on the -[workflows' client](/workflows/creating). +workflows' client. ```python Python (Sync) @@ -132,7 +132,7 @@ To delete a cluster, you can use the `delete` method and pass in a cluster's slu ## Jobs spanning different clusters -[When submitting a job](/workflows/job) you need to specify the cluster that the job should be submitted to. +[When submitting a job](/workflows/concepts/jobs) you need to specify the cluster that the job should be submitted to. This allows you to target a specific group of task runners for a particular job. All sub-tasks within the job are submitted to the same cluster by default. This can also be manually overridden to submit sub-tasks to other clusters if needed. Check out the example below to see how this can be done. diff --git a/workflows/concepts/jobs.mdx b/workflows/concepts/jobs.mdx index f84d564..d77dc3b 100644 --- a/workflows/concepts/jobs.mdx +++ b/workflows/concepts/jobs.mdx @@ -20,7 +20,7 @@ Once a job is submitted, its root task is scheduled for execution, and any [elig may pick it up and execute it. For submitting a job, a job client needs to be instantiated first. This can be done by calling the `jobs` method on the -[workflows' client](/workflows/creating). +workflows' client. ```python Python (Sync) @@ -115,7 +115,7 @@ and [dependencies](/workflows/concepts/tasks#dependencies), it's possible to vis Assuming you have submitted a job, you can use the `display` method on the job client to display the execution of the job as a graph diagram. - The `display` method is designed to be used in an [interactive environment](/sdks/python/jupyter), such as a Jupyter notebook. + The `display` method is designed to be used in an [interactive environment](/sdks/python/sample-notebooks#interactive-environments), such as a Jupyter notebook. In non-interactive environments, use `job_client.visualize` instead which returns the rendered diagram as a string in the SVG format.