Skip to content

docs: update README with full feature docs#3

Closed
piotrski wants to merge 1 commit into
devfrom
docs/readme
Closed

docs: update README with full feature docs#3
piotrski wants to merge 1 commit into
devfrom
docs/readme

Conversation

@piotrski
Copy link
Copy Markdown
Collaborator

@piotrski piotrski commented Feb 9, 2026

Summary

  • Add features list, architecture diagram, CLI usage, connecting a React app, and development sections to the README

🤖 Generated with Claude Code

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Feb 9, 2026

⚠️ No Changeset found

Latest commit: 04837b5

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

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 04837b5cf2

ℹ️ 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".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +58 to +59
# MCP server (stdio transport)
agent-react-devtools serve-mcp
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove or implement the MCP server command

The README advertises an MCP server and a serve-mcp CLI command, but the CLI implementation only supports start|stop|status|get|find|count (see packages/agent-react-devtools/src/cli.ts) and there is no MCP server wiring anywhere in the package (no @modelcontextprotocol/sdk usage). As written, running agent-react-devtools serve-mcp will hit the unknown-command path and fail; either implement the MCP server entrypoint or remove the documentation to avoid a broken user flow.

Useful? React with 👍 / 👎.

Comment thread README.md
Comment on lines +49 to +56
# Profiling
agent-react-devtools profile start [session-name]
agent-react-devtools profile stop
agent-react-devtools profile report @c1
agent-react-devtools profile slow [--limit N]
agent-react-devtools profile rerenders [--limit N]
agent-react-devtools profile timeline [--limit N]
agent-react-devtools profile commit #3 [--limit N]
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Remove or implement profiling CLI commands

The README lists a suite of profile subcommands, but the CLI and IPC types do not define any profile commands (only get-tree, get-component, find, and count are supported in packages/agent-react-devtools/src/cli.ts and packages/agent-react-devtools/src/types.ts). Users following the README will get “Unknown command” for any agent-react-devtools profile ... invocation; either implement these subcommands or update the docs to match the current capabilities.

Useful? React with 👍 / 👎.

@piotrski piotrski deleted the branch dev February 9, 2026 22:04
@piotrski piotrski closed this Feb 9, 2026
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.

1 participant