From edbf1684f353f18343d38532a01840adbfad5e25 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Thu, 25 Jun 2026 04:41:13 +0000 Subject: [PATCH] docs: expand short frontmatter descriptions on v6 pages --- docs/v6/guides/creating-an-environment.mdx | 2 +- docs/v6/guides/running-an-eval.mdx | 2 +- docs/v6/reference/capabilities.mdx | 2 +- docs/v6/reference/cli.mdx | 2 +- docs/v6/reference/environment.mdx | 2 +- docs/v6/reference/runtime.mdx | 2 +- docs/v6/reference/tasks.mdx | 2 +- docs/v6/reference/training.mdx | 2 +- docs/v6/start/overview.mdx | 2 +- 9 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/v6/guides/creating-an-environment.mdx b/docs/v6/guides/creating-an-environment.mdx index 317cea8e..63fc168b 100644 --- a/docs/v6/guides/creating-an-environment.mdx +++ b/docs/v6/guides/creating-an-environment.mdx @@ -1,6 +1,6 @@ --- title: "Creating Environments" -description: "Scaffold an environment, write its env.py, test it locally, and deploy it to the platform." +description: "Scaffold a HUD environment, implement env.py with tasks and capabilities, test it locally with the CLI, and deploy it to the HUD platform." icon: "hammer" mode: "wide" --- diff --git a/docs/v6/guides/running-an-eval.mdx b/docs/v6/guides/running-an-eval.mdx index ad7a2187..15c309f3 100644 --- a/docs/v6/guides/running-an-eval.mdx +++ b/docs/v6/guides/running-an-eval.mdx @@ -1,6 +1,6 @@ --- title: "Evaluating Agents" -description: "Point an agent at a set of tasks, choose where each rollout runs, and read the reward." +description: "Point an agent at a HUD taskset, pick a runtime for each rollout, run the evaluation, and read the rewards your graders return for every task." icon: "play" mode: "wide" --- diff --git a/docs/v6/reference/capabilities.mdx b/docs/v6/reference/capabilities.mdx index 808344e7..1faed11b 100644 --- a/docs/v6/reference/capabilities.mdx +++ b/docs/v6/reference/capabilities.mdx @@ -1,6 +1,6 @@ --- title: "Capabilities" -description: "The wire protocols an environment exposes, each protocol's factory signature, and the clients that attach to them." +description: "Reference for HUD capabilities: the wire protocols an environment exposes, each capability's factory signature, and the clients agents use to attach." icon: "plug" --- diff --git a/docs/v6/reference/cli.mdx b/docs/v6/reference/cli.mdx index 807bd9b6..6a5f51bb 100644 --- a/docs/v6/reference/cli.mdx +++ b/docs/v6/reference/cli.mdx @@ -1,6 +1,6 @@ --- title: "CLI" -description: "The hud command reference across the environment lifecycle." +description: "Reference for the hud command-line interface: init, dev, run, eval, models, and other commands that span the HUD environment and agent lifecycle." icon: "terminal" --- diff --git a/docs/v6/reference/environment.mdx b/docs/v6/reference/environment.mdx index 45f35e89..6a38f8c9 100644 --- a/docs/v6/reference/environment.mdx +++ b/docs/v6/reference/environment.mdx @@ -1,6 +1,6 @@ --- title: "Environments" -description: "The Environment control object, its registration methods, and how to serve one over the wire protocol." +description: "Reference for the HUD Environment object: registering tasks, capabilities, and lifecycle hooks, plus serving an environment over the wire protocol." icon: "cube" --- diff --git a/docs/v6/reference/runtime.mdx b/docs/v6/reference/runtime.mdx index 1663861c..1db44baa 100644 --- a/docs/v6/reference/runtime.mdx +++ b/docs/v6/reference/runtime.mdx @@ -1,6 +1,6 @@ --- title: "Runtimes" -description: "Where each rollout's environment runs - the runtime you pass at execution time." +description: "Reference for HUD runtimes: local Docker, remote workers, and the platform runtime that decides where each rollout's environment is started and executed." icon: "rocket" --- diff --git a/docs/v6/reference/tasks.mdx b/docs/v6/reference/tasks.mdx index 55e871e8..0a764ed5 100644 --- a/docs/v6/reference/tasks.mdx +++ b/docs/v6/reference/tasks.mdx @@ -1,6 +1,6 @@ --- title: "Tasks & Tasksets" -description: "What a task is, how you define one, and how a single definition becomes a whole dataset you can run, group into jobs, and sync." +description: "Reference for HUD Task and Taskset: defining a single task, expanding it into a dataset, grouping tasks into jobs, and syncing tasksets to the platform." icon: "list-check" --- diff --git a/docs/v6/reference/training.mdx b/docs/v6/reference/training.mdx index 6ae60c78..db13d730 100644 --- a/docs/v6/reference/training.mdx +++ b/docs/v6/reference/training.mdx @@ -1,6 +1,6 @@ --- title: "Training" -description: "The TrainingClient API, training paths, losses, results, and the hud models CLI." +description: "Reference for HUD training: the TrainingClient API, supported training paths, loss functions, run results, and the hud models CLI for managing forks." icon: "dumbbell" mode: "wide" --- diff --git a/docs/v6/start/overview.mdx b/docs/v6/start/overview.mdx index 139b7ac7..35ef95bb 100644 --- a/docs/v6/start/overview.mdx +++ b/docs/v6/start/overview.mdx @@ -1,6 +1,6 @@ --- title: "Overview" -description: "A concise, high-level explanation of core HUD concepts and the central workflow in one page." +description: "A high-level tour of HUD's core concepts - environments, tasks, capabilities, agents, runtimes, and graders - and how they connect in the central workflow." icon: "compass" mode: "wide" ---