Skip to content

Commit 273c347

Browse files
authored
Merge pull request #135 from satoryu/claude/add-documentation-cxdBu
docs: add comprehensive architecture and development guideline documentation
2 parents 47fda2c + fc5c649 commit 273c347

3 files changed

Lines changed: 2165 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ This document provides comprehensive guidance for AI agents working on the Copy
2929

3030
## Architecture
3131

32+
> **📖 For detailed architecture documentation including module dependencies, data flows, and design decisions, see [docs/architecture.md](docs/architecture.md)**
33+
3234
### Project Structure
3335

3436
```
@@ -52,6 +54,9 @@ This document provides comprehensive guidance for AI agents working on the Copy
5254
├── public/ # Static files
5355
│ ├── _locales/ # i18n messages
5456
│ └── icon/ # Extension icons
57+
├── docs/ # Documentation
58+
│ ├── architecture.md # Module dependencies and design
59+
│ └── development-guideline.md # Development guidelines
5560
├── wxt.config.ts # WXT configuration
5661
├── tsconfig.json # TypeScript config
5762
└── vitest.config.ts # Test configuration
@@ -70,6 +75,8 @@ This document provides comprehensive guidance for AI agents working on the Copy
7075

7176
## Development Guidelines
7277

78+
> **📖 For comprehensive development guidelines including TDD workflow, coding standards, testing strategy, Git workflow, and common tasks, see [docs/development-guideline.md](docs/development-guideline.md)**
79+
7380
### Coding Conventions
7481

7582
1. **TypeScript First**
@@ -553,7 +560,9 @@ npm run dev # Test in browser
553560
- `README.md` - User-facing documentation
554561
- `CONTRIBUTING.md` - Contribution guidelines
555562
- `CODE_OF_CONDUCT.md` - Community standards
556-
- `docs/` - GitHub Pages documentation site
563+
- `CLAUDE.md` (this file) - AI agent development guide
564+
- `docs/architecture.md` - **Module dependencies, data flows, and architectural design**
565+
- `docs/development-guideline.md` - **Comprehensive development guidelines (TDD, coding standards, workflows)**
557566

558567
## Working with WXT
559568

@@ -628,7 +637,11 @@ Based on codebase analysis, here are areas for enhancement:
628637

629638
## Resources
630639

631-
### Documentation
640+
### Project Documentation
641+
- **[Architecture Documentation](docs/architecture.md)** - Module dependencies, layered architecture, data flows, design decisions
642+
- **[Development Guidelines](docs/development-guideline.md)** - TDD workflow, coding standards, testing, Git workflow, common tasks
643+
644+
### External Documentation
632645
- [WXT Documentation](https://wxt.dev/)
633646
- [Chrome Extension Docs](https://developer.chrome.com/docs/extensions/)
634647
- [Scrapbox Help](https://scrapbox.io/help/)
@@ -673,6 +686,10 @@ npm run build && npm run zip
673686

674687
## For AI Agents: Special Instructions
675688

689+
> **📖 Important Resources for AI Agents:**
690+
> - **[docs/architecture.md](docs/architecture.md)** - Understand module dependencies before making changes
691+
> - **[docs/development-guideline.md](docs/development-guideline.md)** - Follow detailed development workflow and best practices
692+
676693
### When Making Changes
677694

678695
**CRITICAL: This project follows Test-Driven Development (TDD). Always write tests BEFORE implementation.**

0 commit comments

Comments
 (0)