Repository navigation
docs(explore): shorten the explore guide, move the detail to the CLI reference - #969
Merged
Merged
Conversation
…reference Reorder the page by what a user does (run, write a goal, read the results, sign in, raise the budget) and rewrite it in a plain, simplified-English voice. The verdict table, per-step budgets, stuck rule, severity scale, artifact directory, and notices move to the e2e explore section of the CLI reference; the credentials paragraph moves to the security page, which linked to the removed anchor. Also corrects two claims: with no credentials the explorer signs in with made-up ones, and the artifact directory digest covers the target and agent too.
kacperkapusciak
requested review from
okwasniewski and
szymonrybczak
as code owners
October 7, 2026 21:20
okwasniewski
approved these changes
Oct 7, 2026
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.
The explore guide had grown into half guide, half reference. This cuts it from 1,241 to about 660 words and moves the reference detail to the reference pages, so no fact is lost.
docs/explore.mdx: reordered by what a user does: run it, write a goal, read the results, start signed in, raise the budget, pick the target and agent. Rewritten in a plain, simplified-English voice (short sentences, active voice, one term per concept).docs/reference/cli.mdx(e2e explore) now holds what left the guide: the verdict table with exit codes (replacing the old one-line summary, Ctrl-C kept), per-step action and model-call budgets, the three-failuresstuckrule, issue vs warning and severity order, no screenshots after a secret fill, the artifact directory,markdownwritingsummary.md, the--videonotices,systemin the--agentrow,MODEL_UNAVAILABLE, and opening the app when the target declaresapp.url.docs/security.mdx: the credentials paragraph moves here. It linked to/explore#your-config-applies, which no longer exists.Two claims were wrong before and are corrected here:
packages/e2e/src/explore/plan.ts:188,packages/e2e/src/explore/executor.ts:20). The old page said it skips password sign-in.packages/e2e/src/run/artifacts.ts:345,packages/e2e/src/report/build.ts:508), not the goal alone.No changeset: docs only.
Verified
Ran it locally: yes
pnpm docs:dev, pages rendered in Chromium: the new guide, thee2e exploresection of the CLI reference, and the security page's "MCP and explore" section.pnpm checkpasses, includingmint validateandmint broken-links. No link indocs/,skills/, orsrc/points to a removed/explore#anchor.The moved detail in the CLI reference: