This repository was archived by the owner on Mar 9, 2026. It is now read-only.
Repository navigation
docs: refactor CLAUDE.md, AGENTS.md, and skills/README.md for clarity and separation of concerns - #51
Merged
Merged
Conversation
…ev tooling info Remove content duplicated with AGENTS.md/README.md (coverage lists, API docs, type definitions, JSDoc details, architecture notes) and add missing development information (toolchain table, lint/format commands, CI/CD workflow locations). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rename "Purpose" under Agent Skills to "What are Agent Skills?" to avoid duplicate heading with the top-level "Purpose" section. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The project description already exists in README.md and AGENTS.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Tool compatibility tables belong in each tool's own documentation, not in the project's design rules document. This avoids staleness and keeps AGENTS.md focused on implementation rules. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
…ills/ Remove sections that are not implementation rules: - Security guarantees (pointer-only, zero original content) - v0.1.0 scope (frozen historical info) - Versioning (pointer-only) - Agent Skills (infrastructure/maintenance, not design rules) Move detailed maintenance steps to skills/README.md where they belong. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove Supported Tools and Relationship to AGENTS.md sections from skills/README.md (staleness-prone, redundant with Maintenance Policy). Fix CLAUDE.md broken reference to deleted AGENTS.md "Agent Skills" section — now points to "Design rules" and "Security rules". Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
roottool
marked this pull request as ready for review
February 15, 2026 05:57
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #51 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 22 22
Branches 6 6
=========================================
Hits 22 22 🚀 New features to boost your workflow:
|
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Description
Refactor documentation files to enforce strict separation of concerns, eliminate cross-file duplication, and add missing development information.
Type of Change
Boundary Checklist (Required for Implementation Changes)
Changes
CLAUDE.md (Claude Code working guide)
lint,format,fix,check)check:type,check:package)prepare:publish)AGENTS.md (implementation rules)
skills/README.md (skills directory guide)
Motivation
CLAUDE.md had significant duplication with AGENTS.md while missing practical development commands. AGENTS.md contained non-rule sections (pointers, historical info, infrastructure docs) that diluted its purpose as an implementation rules document. This PR enforces each file's stated purpose.
Testing
Related
🤖 Generated with Claude Code
Co-Authored-By: Claude noreply@anthropic.com