Skip to content

docs: Fix README wording and installation guidance#41780

Open
handsupmin wants to merge 1 commit intoanthropics:mainfrom
handsupmin:codex/docs-readme-fixes
Open

docs: Fix README wording and installation guidance#41780
handsupmin wants to merge 1 commit intoanthropics:mainfrom
handsupmin:codex/docs-readme-fixes

Conversation

@handsupmin
Copy link
Copy Markdown

Summary

  • fix the grammar typo in examples/settings/README.md
  • update plugins/README.md to point readers to the recommended Claude Code setup documentation instead of the deprecated global npm install path

Why

  • the settings examples README had a small wording error
  • the plugin installation section had drifted from the root README and still suggested a deprecated install method

Impact

  • reduces confusion for readers following installation guidance
  • keeps the repository's README-level documentation aligned

Root cause

  • documentation drift between the root README and the plugin-specific README

Validation

  • git diff --check origin/main...HEAD

@handsupmin handsupmin marked this pull request as ready for review April 1, 2026 04:24
@handsupmin handsupmin changed the title [codex] Fix README wording and installation guidance docs: Fix README wording and installation guidance Apr 1, 2026
Copy link
Copy Markdown

@sandipkatel sandipkatel left a comment

Choose a reason for hiding this comment

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

Global Claude code installation guide.

Comment thread plugins/README.md
```bash
npm install -g @anthropic-ai/claude-code
```
1. Install Claude Code using one of the recommended methods from the [setup documentation](https://docs.claude.com/en/docs/claude-code/setup).
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This may not be necessary for short and quick installation.

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