Skip to content

docs: sync documentation with recent code changes#3

Open
fvegiard wants to merge 2 commits into
mainfrom
docs/sync-docs-with-recent-changes
Open

docs: sync documentation with recent code changes#3
fvegiard wants to merge 2 commits into
mainfrom
docs/sync-docs-with-recent-changes

Conversation

@fvegiard
Copy link
Copy Markdown
Owner

Documentation Updates

Syncs documentation with recent code changes that introduced new plugins and example settings files.

Changes

CLAUDE.md:

  • Added examples/settings/ to the repository overview section
  • Added 4 missing plugins to the Available Plugins table:
    • claude-opus-4-5-migration (added in a194a9d)
    • explanatory-output-style
    • frontend-design
    • learning-output-style

README.md:

plugins/README.md:

  • Updated installation instructions to use recommended methods (curl/irm) instead of deprecated npm install -g (aligned with b640d94)

Notes

This PR was generated with Oz.

- Add 4 missing plugins to CLAUDE.md table (claude-opus-4-5-migration,
  explanatory-output-style, frontend-design, learning-output-style)
- Add examples/settings reference to CLAUDE.md and README.md
- Update plugins/README.md installation instructions to use recommended
  methods instead of deprecated npm install

Co-Authored-By: Oz <oz-agent@warp.dev>
Copilot AI review requested due to automatic review settings March 24, 2026 05:04
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates repository documentation to reflect recently added settings examples and plugins, and to align plugin installation guidance with the current recommended install methods.

Changes:

  • Add an “Example Settings” section to the main README pointing to examples/settings/.
  • Extend CLAUDE.md repository overview and plugin list with newly added plugins and settings examples.
  • Update plugins/README.md installation instructions to use the recommended curl/irm flows instead of deprecated npm install -g.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
plugins/README.md Replaces global npm install instructions with recommended install methods and links to main README.
README.md Adds a new section linking to examples/settings/ and its README.
CLAUDE.md Adds examples/settings/ to repo overview and adds missing plugins to the Available Plugins table.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread plugins/README.md
Comment on lines +33 to +43
1. Install Claude Code using one of the [recommended methods](../README.md#get-started):

**MacOS/Linux:**
```bash
curl -fsSL https://claude.ai/install.sh | bash
```

**Windows:**
```powershell
irm https://claude.ai/install.ps1 | iex
```
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

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

PR description says changes are "strictly additive", but this hunk removes the existing npm install -g installation step and replaces it with curl/irm instructions. Consider updating the PR description (or Notes section) to reflect that this is a replacement/removal of deprecated guidance, not purely additive.

Copilot uses AI. Check for mistakes.
Sync docs/sync-docs-with-recent-changes with main
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