docs(v6): restructure docs into guides + reference and refresh the start section#473
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
The blank preset downloaded hud-evals/hud-blank (calculator + in-process MCP example) instead of the simple letter-counting scaffold. Mark blank as a local preset so it writes the bundled strawberry scaffold with no network fetch, and document the behavior in the CLI reference. Co-authored-by: Cursor <cursoragent@cursor.com>
Move core docs into reference/, relocate protocol under advanced/, drop the old build overview page, and update docs.json, skill.md, and cross-links across cookbooks, FAQ, and start pages. Co-authored-by: Cursor <cursoragent@cursor.com>
Add walkthrough pages for the env.py/tasks.py split layout and for training models with HUD. Co-authored-by: Cursor <cursoragent@cursor.com>
Add a step-by-step guide for scaffolding an environment, defining tasks, and running a first eval with the blank strawberry template. Co-authored-by: Cursor <cursoragent@cursor.com>
Add a guide for configuring agents, running evals locally, and reading results with hud eval. Co-authored-by: Cursor <cursoragent@cursor.com>
Replace the old build overview with a start-page overview that orients new users around the v6 docs structure and core workflows. Co-authored-by: Cursor <cursoragent@cursor.com>
Extend custom.css with layout and typography tweaks for the restructured v6 documentation site. Co-authored-by: Cursor <cursoragent@cursor.com>
Restructure the env.py walkthrough around a workspace-backed counter example with numbered double-pane parts for the environment, capabilities, lifecycle hooks, and tasks. Add platform caveats, key requirements, and a hud serve note, and rename the eval guide page title to "Evaluating Agents". Co-authored-by: Cursor <cursoragent@cursor.com>
Align the evaluation guide with the house style: wide mode, a plain opener, verb-phrase section titles, lowercase link text, and a prose closer instead of a CardGroup. Flatten the unbalanced two-column split, drop the section dividers, standardize on "platform" over "dashboard", and remove the reference to the not-yet-live environment catalog. Co-authored-by: Cursor <cursoragent@cursor.com>
Rename the training-models guide to training-agents and rewrite it in the style of the creating-an-environment and running-an-eval guides: a four-step loop, a double-pane train.py walkthrough, and group/checkpoint sections, with deeper API detail left to the training reference. Add a scoped step-list CSS class for compact lists in split panes that keeps standard line spacing without the negative-margin overlap of tight-list. Delete the split-layout demo page and its navigation entry. Co-authored-by: Cursor <cursoragent@cursor.com>
Reframe all five cookbook pages against the docs-write conventions and the running-an-eval house style, preserving every fact, code block, and See also group while improving readability. - index: drop em dashes, motivate cookbooks as worked end-to-end evals - coding-agent: lead with the mental model, cut "one design point" filler, standardize the ssh capability name - ops-diagnostics: define an investigation task by why it is hard - a2a-chat: turn the env-var paragraph into a table, define Chat on first use - robot-benchmark: define bridge/endpoint/contract, fix bare-identifier opening, split the dense rollout paragraph into a bold-lead-in list Co-authored-by: Cursor <cursoragent@cursor.com>
Rework the v6 reference set (agents, capabilities, environment, graders, runtime, tasks, training, types) into a tighter, signature-first style, and fix the extending cross-link to the new environment anchors. Align the capabilities and environment pages with main's "enable workspace file tracking by default" change: remove filetracking as a public capability and drop the FileTrackingClient, and document file tracking as workspace-owned telemetry that runs by default (opt out with track_files=False or HUD_FILE_TRACKING_ENABLED=false). Co-authored-by: Cursor <cursoragent@cursor.com>
Add an on-this-page directory, an export-to-other-formats section linking Harbor, and a see-environment-examples section pointing to hud init and the cookbooks. Fix the trailing eval-guide link and update environment cross-links to the new reference anchors. Co-authored-by: Cursor <cursoragent@cursor.com>
Restore the HUD intro on the introduction page and restructure reading-the-docs around Guides and Reference, pointing cookbooks at its index. Tighten the overview wording and fix the Job anchor, and keep the overview step pills on one line with a mermaid label overflow rule. Co-authored-by: Cursor <cursoragent@cursor.com>
Import LocalRuntime from the public `hud` package rather than `hud.eval`. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
|
Docs PR opened: #474 Expanded short frontmatter descriptions on nine v6 guide, reference, and start pages to meet the 130–160 character SEO target. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
The v6
core/section mixed conceptual walkthroughs with API reference, thestart pages were stale, and some pages drifted from the SDK (notably file
tracking, now a default-on workspace feature on main, not a public capability).
Solution
core/into hands-onguides/(creating environments, evaluatingagents, training agents) and API
reference/; moveprotocoltoadvanced/,drop dead
build/overview, update nav.overview, restore the## HUDintro, andrebuild "reading the docs" around Guides and Reference.
default: drop
filetrackingas a public capability andFileTrackingClient.hud initblank now writes the local scaffold; add thecustom.csscomponents the guides use.
Outcome / Verification
guides/+reference/structure.Capability.filetracking/FileTrackingClientremain (verified by search); defaults match
settings.py/workspace.py.hud eval tasks.py claude(reward 1.0).Note
Low Risk
Documentation-only changes (nav, redirects, copy, and CSS); no runtime or SDK behavior changes in this diff.
Overview
Reorganizes the v6 SDK docs so Guides hold the hands-on flows (creating environments, running evals, training) and Reference holds API-style pages moved out of the old
core/tree. Protocol moves to Advanced,build/overviewis removed, and Start gains overview in the sidebar.Navigation and links:
docs.jsonis rewired (collapsible Advanced/Cookbooks), with redirects from/v6/core/*,/v6/build/*, and/v6/run/*to the new paths. README, skill.md, cookbooks, FAQ, and migration pages are updated to point at/v6/reference/*and the new guides.Content changes: New guide MDX uses guide-row, filetree, and step-list styling added in
custom.css(plus Mermaid font fixes and collapsible sidebar heading styles). Reference pages are rewritten more signature-first; workspace file tracking is documented as default-on viaenv.workspace/ settings, not as a separate publicfiletrackingcapability. The protocol sequence diagram now shows hello → manifest instead of a generic manifest exchange.CLI docs:
hud initdocumentsblankas the default local scaffold (not only GitHub presets).Reviewed by Cursor Bugbot for commit f75d142. Bugbot is set up for automated code reviews on this repo. Configure here.