Skip to content

docs: Shorten Debugging with agents, give agents the __DC__ steps - #4447

Merged
ntucker merged 11 commits into
masterfrom
claude/project-thread-04l2v7
Oct 23, 2026
Merged

ntucker merged 11 commits into
masterfrom
claude/project-thread-04l2v7

Conversation

@ntucker

@ntucker ntucker commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

Requested by Nathaniel · project thread

Motivation

"Debugging with agents" on the Debugging page explained internals to humans, and agents reading the page's .md/llms version got the same human prose plus the manual Redux DevTools walkthrough, instead of the debugging guide the skill gives them.

Solution

  • Site (<SiteOnly>): leads with what globalThis.__DC__ gives agents, one example prompt, the browser tools it needs, and an issue link plus a prompt that has the agent draft the bug report (searches for duplicates, follows the bug template, leaves out app data, shows the draft first). Manual debugging is site-only.
  • Agents (<AgentOnly>, in .md and llms.txt): the whole docs/core/_agents/devtools-debugging.md guide (the same source as the skill's devtools-debugging reference), plus one line telling the agent to point the user to the browser extension if they want to inspect manually.
  • remarkFramework removes <AgentOnly> on the site before the table of contents is built, so agent-only content can hold headings and partials.
  • In page markdown, links to _agents pages (browser setup guides) go to the skill's generated copy on GitHub (agentReferenceUrl), since those pages aren't published.

The #debugging-with-agents anchor is unchanged.

🤖 Generated with Claude Code

https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7


Note

Low Risk
Documentation and static-site markdown generation only; no runtime app or API behavior changes.

Overview
Splits the Debugging page so humans and agents get different content: site readers see a shorter Debugging with agents section (__DC__, example prompts, required browser tools, issue/report prompts) while Manual debugging stays site-only; agent-facing .md / llms.txt output keeps the full devtools-debugging guide via <AgentOnly> plus a line pointing users to the Redux DevTools section on the site.

Pipeline changes: remarkFramework now drops <AgentOnly> when building the Docusaurus site (default) but preserves it when docsToMarkdown runs with keepAgentOnly: true, so agent-only blocks can include headings and _agents/ partials without polluting the site TOC. llms-plugin resolves links to unpublished /_agents/ routes to the matching skill reference on GitHub (agentReferenceUrl). Contributor rules in .claude / .cursor skills-sync docs are updated to match.

Reviewed by Cursor Bugbot for commit 94e098a. Bugbot is set up for automated code reviews on this repo. Configure here.

The site section now shows what to ask your agent and what it needs.
The .md/llms version instead tells agents how to read __DC__, with the
recent-actions and errors snippets, and where the full devtools-debugging
reference is. check:browser-snippets fails if those copies drift.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
@ntucker ntucker self-assigned this Oct 21, 2026
The Debugging page's agent steps and the devtools-debugging reference
now import the same recent-actions and errors partials, so the drift
check is gone. Trimmed the agent prose to the steps and one pointer.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Docs preview: https://docs-site-pr-4447-data-client.vercel.app

Built from 94e098a merged into master (this build).

The Debugging page's agent steps now also import the response-for-a-key
snippet, say to await with CDP like the reference does, and note the
Todo placeholders. The rule, README and checker header say partials hold
some snippets.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
@changeset-bot

changeset-bot Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 94e098a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@changeset-bot

changeset-bot Bot commented Oct 21, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4aa1c42

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T18:14:43.254111Z 94e098a New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
…n't work with

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
…tion

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
…page

The page's markdown (.md, llms.txt) now embeds docs/core/_agents/devtools-debugging.md
in <AgentOnly>, so agents reading it get what the skill reference gives, plus one
line on the browser extension to tell the user about. Manual debugging is site-only.

remarkFramework strips <AgentOnly> on the site before the table of contents is
built, so it can hold headings and partials. Links to _agents pages in page
markdown go to the skill's generated copy on GitHub. The issue prompt now checks
for duplicates, follows the bug template, redacts app data and asks first.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
…mark flag keepAgentOnly

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GdtHs1YHGyHL3LtFQtD1W7
@ntucker
ntucker added this pull request to the merge queue Oct 23, 2026
Merged via the queue into master with commit 0703245 Oct 23, 2026
28 checks passed
@ntucker
ntucker deleted the claude/project-thread-04l2v7 branch October 23, 2026 18:21

This branch was successfully deployed

1 active deployment
docs-preview — 94e098a7 Deployed Oct 23, 2026 by ntucker via docs deploy #3778
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants