From 9c483a49c01d83b4f6e3634f8d9f86f3e355865d Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Fri, 19 Jun 2026 22:08:56 +0000 Subject: [PATCH] docs: improve SEO descriptions across v6, platform, and migrate pages --- docs/migrate-v6.mdx | 2 +- docs/platform/agents/chats.mdx | 2 +- docs/platform/environments.mdx | 2 +- docs/platform/index.mdx | 2 +- docs/platform/internal/trace-analysis.mdx | 2 +- docs/platform/models.mdx | 2 +- docs/platform/slack.mdx | 2 +- docs/v6/advanced/chat.mdx | 2 +- docs/v6/advanced/harbor-convert.mdx | 2 +- docs/v6/advanced/integrations.mdx | 2 +- docs/v6/advanced/patterns.mdx | 2 +- docs/v6/advanced/subagents.mdx | 2 +- docs/v6/cookbooks/a2a-chat.mdx | 2 +- docs/v6/cookbooks/coding-agent.mdx | 2 +- docs/v6/cookbooks/ops-diagnostics.mdx | 2 +- docs/v6/cookbooks/robot-benchmark.mdx | 2 +- docs/v6/faq.mdx | 2 +- docs/v6/index.mdx | 2 +- docs/v6/quickstart.mdx | 2 +- docs/v6/reference/agents.mdx | 2 +- docs/v6/reference/capabilities.mdx | 2 +- docs/v6/reference/cli.mdx | 2 +- docs/v6/reference/environment.mdx | 2 +- docs/v6/reference/graders.mdx | 2 +- docs/v6/reference/robots.mdx | 2 +- docs/v6/reference/tasks.mdx | 2 +- docs/v6/reference/training.mdx | 2 +- docs/v6/reference/types.mdx | 2 +- docs/v6/run/models.mdx | 2 +- docs/v6/run/signal.mdx | 2 +- docs/v6/run/training.mdx | 2 +- 31 files changed, 31 insertions(+), 31 deletions(-) diff --git a/docs/migrate-v6.mdx b/docs/migrate-v6.mdx index 1e3bdd070..ea1d0cde6 100644 --- a/docs/migrate-v6.mdx +++ b/docs/migrate-v6.mdx @@ -1,6 +1,6 @@ --- title: "Migrate to v6" -description: "Convert v5 environments (scenarios + tools + MCP serving) to the leaner v6 spec (tasks + capabilities)." +description: "Migrate HUD environments from v5 to v6: replace MCP tools with capabilities, swap @env.scenario for @env.template, and convert task runs." icon: "arrows-rotate" --- diff --git a/docs/platform/agents/chats.mdx b/docs/platform/agents/chats.mdx index 9b38b1fac..7e57c4847 100644 --- a/docs/platform/agents/chats.mdx +++ b/docs/platform/agents/chats.mdx @@ -1,6 +1,6 @@ --- title: "Chat Agents" -description: "Multi-turn conversational agents served over A2A — pair a scenario's tools with a model" +description: "Build multi-turn chat agents on the HUD platform, served over the A2A protocol, by pairing a chat-enabled scenario with a language model." icon: "comments" --- diff --git a/docs/platform/environments.mdx b/docs/platform/environments.mdx index 7e7c9ff57..9f6c606fd 100644 --- a/docs/platform/environments.mdx +++ b/docs/platform/environments.mdx @@ -1,6 +1,6 @@ --- title: "Environments" -description: "Deploy, manage, and monitor agent environments on the HUD platform." +description: "Deploy and monitor HUD agent environments via GitHub repo import, CLI deploy, or prebuilt templates, with live build logs and auto-rebuilds." icon: "cube" --- diff --git a/docs/platform/index.mdx b/docs/platform/index.mdx index bcc3e1a9b..365b4c04d 100644 --- a/docs/platform/index.mdx +++ b/docs/platform/index.mdx @@ -1,6 +1,6 @@ --- title: "Overview" -description: "Navigate the HUD platform to manage models, environments, and tasksets." +description: "Overview of the HUD platform dashboard for managing AI agent models, environments, tasksets, traces, API keys, and team settings at hud.ai." icon: "building" --- diff --git a/docs/platform/internal/trace-analysis.mdx b/docs/platform/internal/trace-analysis.mdx index 0e376b089..848b3f553 100644 --- a/docs/platform/internal/trace-analysis.mdx +++ b/docs/platform/internal/trace-analysis.mdx @@ -1,6 +1,6 @@ --- title: "Trace Analysis Environment" -description: "How we built an environment to let agents analyze their own traces—and how you can apply the same pattern" +description: "How HUD built an agent-driven trace analysis environment using coding tools and preprocessed files to debug failed evaluations at scale." icon: "magnifying-glass-chart" --- diff --git a/docs/platform/models.mdx b/docs/platform/models.mdx index 040849c01..a6c6a1f09 100644 --- a/docs/platform/models.mdx +++ b/docs/platform/models.mdx @@ -1,6 +1,6 @@ --- title: "Models" -description: "Browse, fork, and train AI models on the HUD platform." +description: "Browse, fork, and train AI models on the HUD platform: manage checkpoints, inspect inference logs, and route inference through the HUD Gateway." icon: "robot" --- diff --git a/docs/platform/slack.mdx b/docs/platform/slack.mdx index 7f3a7a7e7..d64c9f1de 100644 --- a/docs/platform/slack.mdx +++ b/docs/platform/slack.mdx @@ -1,6 +1,6 @@ --- title: "Slack Integration" -description: "Run HUD scenarios directly from Slack by @mentioning the HUD bot." +description: "Run HUD agent scenarios from Slack by @mentioning the HUD bot: trigger evaluations, list scenarios, and post trace links back to channels." icon: "slack" --- diff --git a/docs/v6/advanced/chat.mdx b/docs/v6/advanced/chat.mdx index d5f6ec49c..b591f111e 100644 --- a/docs/v6/advanced/chat.mdx +++ b/docs/v6/advanced/chat.mdx @@ -1,6 +1,6 @@ --- title: "Chat" -description: "Multi-turn conversational tasks and the Chat runner." +description: "Build multi-turn chat tasks in HUD v6 using message-list prompts and the Chat runner to drive conversations, manage history, and grade replies." icon: "comments" --- diff --git a/docs/v6/advanced/harbor-convert.mdx b/docs/v6/advanced/harbor-convert.mdx index 4cfe05636..c9d4535d9 100644 --- a/docs/v6/advanced/harbor-convert.mdx +++ b/docs/v6/advanced/harbor-convert.mdx @@ -1,6 +1,6 @@ --- title: "Harbor interop" -description: "Load Harbor tasks into the HUD runtime, or export HUD tasks as Harbor folders." +description: "Load Harbor task directories into HUD as tasksets, or export HUD tasks to Harbor folders with Dockerfiles, instruction.md, and graded test scripts." icon: "ship" --- diff --git a/docs/v6/advanced/integrations.mdx b/docs/v6/advanced/integrations.mdx index 96821c68a..9a9d7bf7d 100644 --- a/docs/v6/advanced/integrations.mdx +++ b/docs/v6/advanced/integrations.mdx @@ -1,6 +1,6 @@ --- title: "Integrations" -description: "Use HUD with external agent frameworks and endpoints." +description: "Integrate HUD with external agent frameworks: build custom harnesses, wrap browser-use, point at OpenAI-compatible endpoints, or serve via A2A." icon: "puzzle-piece" --- diff --git a/docs/v6/advanced/patterns.mdx b/docs/v6/advanced/patterns.mdx index a279a1200..3c2ef6fed 100644 --- a/docs/v6/advanced/patterns.mdx +++ b/docs/v6/advanced/patterns.mdx @@ -1,6 +1,6 @@ --- title: "Patterns" -description: "Compose capabilities, manage state, and structure larger task sets." +description: "Patterns for HUD v6 environments: compose capabilities, manage stateful daemons, parameterize task difficulty, and group rollouts for variance." icon: "shapes" --- diff --git a/docs/v6/advanced/subagents.mdx b/docs/v6/advanced/subagents.mdx index 22f35f807..6093c4eff 100644 --- a/docs/v6/advanced/subagents.mdx +++ b/docs/v6/advanced/subagents.mdx @@ -1,6 +1,6 @@ --- title: "Subagents as tools" -description: "Expose a specialist sub-agent as a plain MCP tool an orchestrator can call." +description: "Expose a specialist HUD subagent as an MCP tool an orchestrator can call, by wrapping a task rollout in a FastMCP-registered function." icon: "diagram-project" --- diff --git a/docs/v6/cookbooks/a2a-chat.mdx b/docs/v6/cookbooks/a2a-chat.mdx index 60c7707ba..3c8882549 100644 --- a/docs/v6/cookbooks/a2a-chat.mdx +++ b/docs/v6/cookbooks/a2a-chat.mdx @@ -1,6 +1,6 @@ --- title: "A2A chat" -description: "Serve a chat task over the A2A protocol and talk to it from any client." +description: "Serve a HUD chat task over the A2A protocol with a reference server: per-context Chat sessions, agent card, and citations artifacts." icon: "plug" --- diff --git a/docs/v6/cookbooks/coding-agent.mdx b/docs/v6/cookbooks/coding-agent.mdx index 75941d6d7..426201124 100644 --- a/docs/v6/cookbooks/coding-agent.mdx +++ b/docs/v6/cookbooks/coding-agent.mdx @@ -1,6 +1,6 @@ --- title: "Coding agent" -description: "Run a coding agent against a shell + files environment, graded by tests." +description: "Run a HUD coding agent against a shell + files workspace with a seeded bug, graded by pytest via BashGrader to prevent reward hacking." icon: "code" --- diff --git a/docs/v6/cookbooks/ops-diagnostics.mdx b/docs/v6/cookbooks/ops-diagnostics.mdx index b689bef93..5e0dca776 100644 --- a/docs/v6/cookbooks/ops-diagnostics.mdx +++ b/docs/v6/cookbooks/ops-diagnostics.mdx @@ -1,6 +1,6 @@ --- title: "Ops diagnostics" -description: "An investigation task where the agent integrates evidence to produce a diagnosis." +description: "Build a HUD investigation task where an agent reads logs, deploy history, and traces to diagnose a root cause, graded by an LLM judge." icon: "stethoscope" --- diff --git a/docs/v6/cookbooks/robot-benchmark.mdx b/docs/v6/cookbooks/robot-benchmark.mdx index 649685532..c4a311ae5 100644 --- a/docs/v6/cookbooks/robot-benchmark.mdx +++ b/docs/v6/cookbooks/robot-benchmark.mdx @@ -1,6 +1,6 @@ --- title: "Robot benchmark" -description: "Run a VLA policy against a containerized robot sim, graded by task success." +description: "Run a pi0.5 VLA policy against the LIBERO robot manipulation benchmark in HUD using a Dockerized sim and the beta robot capability." icon: "robot" tag: "Beta" --- diff --git a/docs/v6/faq.mdx b/docs/v6/faq.mdx index 0e8ed1ec4..f3a13179a 100644 --- a/docs/v6/faq.mdx +++ b/docs/v6/faq.mdx @@ -1,6 +1,6 @@ --- title: "FAQ" -description: "Answers to the questions that come up most when getting started with HUD." +description: "Answers common HUD questions about API keys, Docker, GPU needs, platform support, costs, and when to use hud eval, serve, or deploy." icon: "circle-question" --- diff --git a/docs/v6/index.mdx b/docs/v6/index.mdx index 9a7824281..928c21209 100644 --- a/docs/v6/index.mdx +++ b/docs/v6/index.mdx @@ -1,6 +1,6 @@ --- title: "Introduction" -description: "Build, evaluate, and train AI agents on RL environments you define once and run anywhere." +description: "Introduction to the HUD SDK for building reusable RL environments and capabilities that any AI agent, model, or training harness can run." icon: "book" --- diff --git a/docs/v6/quickstart.mdx b/docs/v6/quickstart.mdx index 6835ca590..eeeab82f8 100644 --- a/docs/v6/quickstart.mdx +++ b/docs/v6/quickstart.mdx @@ -1,6 +1,6 @@ --- title: "Quickstart" -description: "Install, write a task, run it against a model, and read the reward." +description: "Install the HUD CLI, write your first task with a prompt and reward, then run it against Claude through the gateway to get a graded trace." icon: "bolt" --- diff --git a/docs/v6/reference/agents.mdx b/docs/v6/reference/agents.mdx index 8b0e5fe24..329fdedd5 100644 --- a/docs/v6/reference/agents.mdx +++ b/docs/v6/reference/agents.mdx @@ -1,6 +1,6 @@ --- title: "Agents" -description: "Built-in agents, their configs, create_agent, and the Run contract." +description: "Reference for HUD's built-in agent classes, create_agent, provider configs, and the Run contract used to drive rollouts against capabilities." icon: "robot" --- diff --git a/docs/v6/reference/capabilities.mdx b/docs/v6/reference/capabilities.mdx index 733ed0917..0016a2baf 100644 --- a/docs/v6/reference/capabilities.mdx +++ b/docs/v6/reference/capabilities.mdx @@ -1,6 +1,6 @@ --- title: "Capabilities" -description: "The connections an environment exposes, how to spin each one up, and the clients that attach to them." +description: "Reference for HUD environment capabilities: ssh shell, mcp tools, cdp browser, rfb VNC, and robot, including how to spin each one up." icon: "plug" --- diff --git a/docs/v6/reference/cli.mdx b/docs/v6/reference/cli.mdx index e79105739..f6da60a2e 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 CLI commands: init, serve, eval, deploy, task, and sync, covering environment build, evaluation, and platform sync." icon: "terminal" --- diff --git a/docs/v6/reference/environment.mdx b/docs/v6/reference/environment.mdx index 0f89a7cad..c0034842c 100644 --- a/docs/v6/reference/environment.mdx +++ b/docs/v6/reference/environment.mdx @@ -1,6 +1,6 @@ --- title: "Environment" -description: "The Environment class: tasks, capabilities, initializers, and serving." +description: "Reference for the HUD Environment class: registering task templates, attaching capabilities, lifecycle hooks, and serving the control channel." icon: "cube" --- diff --git a/docs/v6/reference/graders.mdx b/docs/v6/reference/graders.mdx index dc38a5bb1..f1ea94f2f 100644 --- a/docs/v6/reference/graders.mdx +++ b/docs/v6/reference/graders.mdx @@ -1,6 +1,6 @@ --- title: "Graders" -description: "Native graders, comparison helpers, and the native grade combiner." +description: "Reference for HUD graders including BashGrader, LLMJudgeGrader, comparison helpers like exact_match and contains, and the combine function." icon: "scale-balanced" --- diff --git a/docs/v6/reference/robots.mdx b/docs/v6/reference/robots.mdx index 64c2596a1..1b6a69821 100644 --- a/docs/v6/reference/robots.mdx +++ b/docs/v6/reference/robots.mdx @@ -1,6 +1,6 @@ --- title: "Robots" -description: "The robot capability: contracts, bridges, and the agent harness." +description: "Reference for HUD's beta robot capability: RobotBridge, RobotEndpoint, RobotAgent, and the openpi-style observation and action contract over WebSocket." icon: "robot" tag: "Beta" --- diff --git a/docs/v6/reference/tasks.mdx b/docs/v6/reference/tasks.mdx index 2457ba104..cfa6ebdae 100644 --- a/docs/v6/reference/tasks.mdx +++ b/docs/v6/reference/tasks.mdx @@ -1,6 +1,6 @@ --- title: "Tasks & Tasksets" -description: "The Task, Taskset, Job, and SyncPlan API." +description: "Reference for HUD Task, Taskset, and Job APIs, including task authoring with templates and runtime placement options for local, Docker, or hosted runs." icon: "list-check" --- diff --git a/docs/v6/reference/training.mdx b/docs/v6/reference/training.mdx index 0e2838d43..d64bdbfa5 100644 --- a/docs/v6/reference/training.mdx +++ b/docs/v6/reference/training.mdx @@ -1,6 +1,6 @@ --- title: "Training" -description: "The TrainingClient API, loss set, custom losses, and the hud models CLI." +description: "Reference for the HUD TrainingClient: forward_backward, optim_step, built-in and custom losses, and the hud models CLI for trainable checkpoints." icon: "dumbbell" --- diff --git a/docs/v6/reference/types.mdx b/docs/v6/reference/types.mdx index e6ad97150..0da009b2c 100644 --- a/docs/v6/reference/types.mdx +++ b/docs/v6/reference/types.mdx @@ -1,6 +1,6 @@ --- title: "Types" -description: "Run, Trace, answer and result types, and typed task I/O." +description: "Reference for HUD's serializable types: Run, Trace, Grade, Step, and Answer, exchanged between agents, tasks, and graders during a rollout." icon: "code" --- diff --git a/docs/v6/run/models.mdx b/docs/v6/run/models.mdx index bbc704d1a..43e47d1c9 100644 --- a/docs/v6/run/models.mdx +++ b/docs/v6/run/models.mdx @@ -1,6 +1,6 @@ --- title: "Run on any model" -description: "Evaluate a task with Claude, OpenAI, Gemini, or any OpenAI-compatible endpoint." +description: "Run HUD evaluations against Claude, OpenAI, Gemini, or any OpenAI-compatible endpoint like vLLM using hud eval or the create_agent API in code." icon: "robot" --- diff --git a/docs/v6/run/signal.mdx b/docs/v6/run/signal.mdx index e577dd71f..c41f72820 100644 --- a/docs/v6/run/signal.mdx +++ b/docs/v6/run/signal.mdx @@ -1,6 +1,6 @@ --- title: "Designing tasks for signal" -description: "Build tasks that produce learnable, well-calibrated training signal." +description: "Design HUD tasks that produce learnable RL signal: within-group reward spread, calibrated difficulty, and graders that resist reward hacking." icon: "wave-square" --- diff --git a/docs/v6/run/training.mdx b/docs/v6/run/training.mdx index 557294148..2236bc3a5 100644 --- a/docs/v6/run/training.mdx +++ b/docs/v6/run/training.mdx @@ -1,6 +1,6 @@ --- title: "Train on rewards" -description: "Turn rewarded rollouts into weight updates — on HUD's managed trainer or your own loop." +description: "Train models on HUD rewards using the managed TrainingClient or your own GRPO or PPO loop, with custom losses and trainable forked model checkpoints." icon: "dumbbell" ---