Document plan checks - #37
Open
tpavlu wants to merge 2 commits into
Open
Conversation
Shows each check with its description and action tag, so a reader can see the Edits plan / Reviews in chat / Adds section distinction before the table. Captured from the public product demo. Also splits one 40-word sentence into two per the plainer-English pass.
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
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.
What changed and why
The plan editor's Checks menu — the one-click quality passes you run over a plan before any code is written — was undocumented. This adds
plans/collaboration/checks.mdx, listing the ten generally available checks with their menu labels and descriptions verbatim, and leading with the distinction a reader needs before clicking anything: whether a check edits the plan, adds a section, or only reports findings in chat and waits for confirmation. The page is added to the Collaboration group before Review Requests (run checks, then ask a human), plus one cross-linking sentence each in Best Practices and step 5 of Your First Plan.Verified
All claims confirmed in
ref-tools/ref:plan-app/client/src/components/ChecksMenu.tsx,PLAN_CHECK_DEFINITIONS. Labels and descriptions in the table are copied verbatim from that array; the "Action" column is each check'sactionLabel, which is the tag rendered next to the label in the menu (checks-menu__action-tag).buildPromptTemplatein the same file.auto-editandcoherenceedit the plan in place ("use the Edit tool to make improvements in place"; coherence explicitly "Do not add a new review section");add-sectionappends a new section;chat-reviewprependsCHAT_REVIEW_PROMPT_PREFIX, which instructs a terse numbered list of findings in chat, the question "Which of these should I apply to the plan?", and "Do NOT edit the plan document until the user confirms which items to apply".EditorRightActionControls.tsx; itstitle/aria-labelis "Run plan check". Mobile trigger is reached from the header overflow menu, whose item label is "Run a check" (HeaderOverflowMenu.tsx).handleCheckSelectedcallssendMessage(planId, prompt, null, …)with a null threadId;plan-app/server/src/routes/plansMessages.tscreates a new thread when no threadId is supplied. The thread/agent is namedCheck: <label>(passed astaskShortDescription, surfaced byformatAgentLabelinplan-app/client/src/lib/agentUtils.ts), which is why the page says the thread is named after the check.Unverified / omitted
FeatureFlags.EMOJIMAXXING, a Statsig gate that defaults off and is filtered out ofvisibleCheckswhen off), so most readers would not see it in their menu. Its "Creates new plan" action tag is therefore also absent from the action-tag list. Judgement call: documenting a menu item behind a rollout gate would put the page out of sync with what most users see. If the gate goes to 100%, the check and its action tag can be added in one small edit.PLAN_CHECKSis referenced only by client components, with no MCP tool exposing them, so no claim either way is made.Conflicts
This PR edits
docs.json(one added line in the Collaboration group). Sibling PRs in this batch also editdocs.json, so a small conflict there is expected.Generated by Claude Code