Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

docs: refactor CLAUDE.md, AGENTS.md, and skills/README.md for clarity and separation of concerns - #51

Merged
roottool merged 7 commits into
mainfrom
docs/refactor-claude-md
Feb 15, 2026
Merged

roottool merged 7 commits into
mainfrom
docs/refactor-claude-md

Conversation

@roottool

Copy link
Copy Markdown
Owner

Description

Refactor documentation files to enforce strict separation of concerns, eliminate cross-file duplication, and add missing development information.

Type of Change

  • Documentation (changes to documentation only)

Boundary Checklist (Required for Implementation Changes)

  • This is a non-implementation change (Documentation, Tooling, or CI only)
    • Reason: Documentation-only changes across CLAUDE.md, AGENTS.md, and skills/README.md. No implementation code affected.

Changes

CLAUDE.md (Claude Code working guide)

  • Remove content duplicated with AGENTS.md/README.md (coverage lists, API docs, type definitions, JSDoc details, architecture notes)
  • Remove redundant project overview line
  • Add Toolchain table (bun, tsup, vitest, oxlint, biome, prettier, etc.)
  • Add Linting & Formatting commands (lint, format, fix, check)
  • Add Quality Checks commands (check:type, check:package)
  • Add Publishing command (prepare:publish)
  • Add CI/CD section (workflow locations, PR template, Renovate)
  • Fix fenced code block without language specifier (MD040)
  • Fix broken reference to deleted AGENTS.md "Agent Skills" section

AGENTS.md (implementation rules)

  • Remove pointer-only sections with zero original content (Security guarantees, Versioning)
  • Remove frozen historical info (v0.1.0 scope)
  • Remove Agent Skills infrastructure section (not implementation rules)
  • Remove tool compatibility table (Using Skills in Other Tools)
  • Fix duplicate heading (MD024)

skills/README.md (skills directory guide)

  • Remove Supported Tools section (staleness-prone, each tool's docs are authoritative)
  • Remove Relationship to AGENTS.md section (redundant with Maintenance Policy)
  • Upgrade Maintenance Policy with detailed steps moved from AGENTS.md

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

  • Verified zero content duplication between CLAUDE.md and AGENTS.md
  • Verified all file paths referenced in CLAUDE.md exist
  • Verified all package.json scripts are documented in CLAUDE.md
  • Pre-commit hooks pass on all commits

Related

  • All changes are documentation-only with no impact on runtime behavior

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

roottool and others added 7 commits February 15, 2026 14:36
…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 roottool self-assigned this Feb 15, 2026
@roottool
roottool marked this pull request as ready for review February 15, 2026 05:57
@codecov

codecov Bot commented Feb 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (aafe97c) to head (3beb602).
⚠️ Report is 7 commits behind head on main.

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@roottool
roottool merged commit 62829ad into main Feb 15, 2026
19 checks passed
@roottool
roottool deleted the docs/refactor-claude-md branch February 15, 2026 05:58
@roottool roottool added documentation Improvements or additions to documentation ignore for release Exclude from release notes labels Mar 1, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation ignore for release Exclude from release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant