Ryan Malloy
162ca67098
✨ Features: - 🧠 Shadow learner that builds intelligence from command patterns - 🛡️ Smart command validation with safety checks - 💾 Automatic context monitoring and backup system - 🔄 Session continuity across Claude restarts 📚 Documentation: - Complete Diátaxis-organized documentation - Learning-oriented tutorial for getting started - Task-oriented how-to guides for specific problems - Information-oriented reference for quick lookup - Understanding-oriented explanations of architecture 🚀 Installation: - One-command installation script - Bootstrap prompt for installation via Claude - Cross-platform compatibility - Comprehensive testing suite 🎯 Ready for real-world use and community feedback! 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
99 lines
3.6 KiB
Markdown
99 lines
3.6 KiB
Markdown
# Claude Code Hooks Documentation
|
|
|
|
This documentation is organized using the [Diátaxis framework](https://diataxis.fr/) to serve different types of user needs.
|
|
|
|
## 📚 Documentation Types
|
|
|
|
### 🎓 [Tutorial](tutorial/getting-started.md)
|
|
**Learning-oriented** - For newcomers who want to gain confidence and skill
|
|
|
|
Start here if you're new to Claude Hooks. We'll guide you through your first experience, showing you how the system works by watching it in action.
|
|
|
|
**Time commitment**: 30-45 minutes
|
|
**What you'll gain**: Confidence using Claude with intelligent assistance
|
|
|
|
---
|
|
|
|
### 🛠️ How-To Guides
|
|
**Task-oriented** - For competent users solving specific problems
|
|
|
|
Choose the guide that matches your current need:
|
|
|
|
- **[How to restore from backups](how-to/restore-backup.md)** - When your session crashed or you need to recover work
|
|
- **[How to customize command patterns](how-to/customize-patterns.md)** - Add your own dangerous command patterns or warnings
|
|
- **[How to share learned patterns](how-to/share-patterns.md)** - Share intelligence with your team or across projects
|
|
|
|
---
|
|
|
|
### 📖 Reference
|
|
**Information-oriented** - For looking up facts while working
|
|
|
|
Quick reference for when you need specific details:
|
|
|
|
- **[CLI Commands](reference/cli-commands.md)** - Complete command reference with options and examples
|
|
- **[Hook API](reference/hook-api.md)** - Technical specification for hook input/output
|
|
|
|
---
|
|
|
|
### 💡 Explanation
|
|
**Understanding-oriented** - For gaining deeper insight
|
|
|
|
Read when you want to understand the "why" behind Claude Hooks:
|
|
|
|
- **[Why Claude Code needs intelligent hooks](explanation/why-hooks.md)** - The problems that Claude Hooks solves
|
|
- **[Understanding the shadow learner](explanation/shadow-learner.md)** - How the system builds intelligence through observation
|
|
- **[The architecture of intelligent assistance](explanation/architecture.md)** - How the components work together to create emergent intelligence
|
|
|
|
---
|
|
|
|
## 🚀 Quick Start
|
|
|
|
**New to Claude Hooks?** → Start with the [Tutorial](tutorial/getting-started.md)
|
|
|
|
**Need to solve a problem?** → Check the [How-To Guides](#-how-to-guides)
|
|
|
|
**Looking up syntax or options?** → Use the [Reference](#-reference)
|
|
|
|
**Want to understand how it works?** → Read the [Explanations](#-explanation)
|
|
|
|
---
|
|
|
|
## 🤔 Which Type of Documentation Do I Need?
|
|
|
|
Use this decision tree:
|
|
|
|
```
|
|
Are you currently working on a task?
|
|
├─ Yes → Do you know what you want to accomplish?
|
|
│ ├─ Yes → How-To Guides 📋
|
|
│ └─ No → Reference 📖
|
|
└─ No → Are you learning or exploring?
|
|
├─ Learning → Tutorial 🎓
|
|
└─ Understanding → Explanation 💡
|
|
```
|
|
|
|
---
|
|
|
|
## 📁 Project Navigation
|
|
|
|
- **[Main README](../README.md)** - Project overview and installation
|
|
- **[DEMO](../DEMO.md)** - Quick feature showcase
|
|
- **[Architecture](../CLAUDE.md)** - Technical architecture details
|
|
|
|
---
|
|
|
|
## 🔍 Finding What You Need
|
|
|
|
**Can't find what you're looking for?**
|
|
|
|
1. **Search tip**: Use your browser's find function (Ctrl+F / Cmd+F) on the reference pages
|
|
2. **GitHub search**: Use the repository search to find specific terms across all documentation
|
|
3. **Start broader**: If a specific how-to doesn't exist, try the tutorial or explanation first
|
|
|
|
**Common documentation patterns**:
|
|
- All tutorials use "we" language and step-by-step instruction
|
|
- All how-to guides start with "when to use this guide"
|
|
- All reference pages are organized alphabetically and consistently formatted
|
|
- All explanations can be read away from the computer
|
|
|
|
This organization ensures you get the right type of help for your current situation. |