# PyQt Preview Documentation

Welcome to the comprehensive documentation for PyQt Preview - the live preview tool for PyQt GUI development.

## Getting Started

### For New Users
- **[Getting Started Tutorial](tutorials/getting-started.md)** - Complete hands-on tutorial with examples
- **[Examples](../examples/README.md)** - Working example applications to try

### For Developers
- **[Architecture Guide](guides/architecture-guide.md)** - Detailed technical overview and implementation
- **[Contributing Guide](../CONTRIBUTING.md)** - How to contribute to the project

## Advanced Features

### AI/MCP Integration (Experimental/Future)
- **[Claude Setup](integration/claude-setup.md)** - Set up AI-powered GUI development with Claude *(planned)*
- **[MCP Server Guide](integration/mcp-server-guide.md)** - Model Context Protocol server implementation *(planned)*

### IDE Integration
- **[VS Code Extension](../vscode-extension/README.md)** - IDE integration with live preview *(planned)*
- **[VS Code Development](../vscode-extension/DEVELOPMENT.md)** - Extension development guide *(planned)*

## Documentation Structure

```
docs/
├── README.md                 # This overview file
├── guides/                   # Technical guides and references
│   └── architecture-guide.md # Detailed technical documentation
├── tutorials/                # Step-by-step tutorials
│   └── getting-started.md    # Complete beginner tutorial
├── integration/              # Third-party integrations (future)
│   ├── claude-setup.md       # Claude AI integration (future)
│   └── mcp-server-guide.md   # MCP server documentation (future)
├── api/                      # API documentation (future)
└── vision/                   # Project vision and potential
    └── ai-potential.md       # AI-GUI development vision
```

## Quick Navigation

### By User Type

**New to PyQt Preview?**
Start with the [Getting Started Tutorial](tutorials/getting-started.md)

**Developer wanting to understand the internals?**
Read the [Architecture Guide](guides/architecture-guide.md)

**Interested in AI-powered GUI development?**
Check out [Claude Integration](integration/claude-setup.md) *(planned)*

**Want to contribute or extend?**
See the [Contributing Guide](../CONTRIBUTING.md)

### By Feature

- **Live Reload**: [Architecture Guide - File Watching](guides/architecture-guide.md#file-watcher)
- **UI Compilation**: [Architecture Guide - UI Compiler](guides/architecture-guide.md#ui-compiler)
- **Configuration**: [Getting Started - Configuration](tutorials/getting-started.md#configuration)
- **CLI Commands**: [Main README](../README.md#cli-commands)

## Need Help?

1. **Check the [Getting Started Tutorial](tutorials/getting-started.md)** for common use cases
2. **Review [Examples](../examples/README.md)** for working code
3. **Read [Contributing Guide](../CONTRIBUTING.md)** for development questions
4. **Open an issue** on GitHub for bugs or feature requests

## Documentation Status

| Document                | Status     | Last Updated |
|------------------------|------------|--------------|
| Getting Started Tutorial| Complete   | Current      |
| Architecture Guide      | Complete   | Current      |
| Claude Integration      | Planned    | Future       |
| MCP Server Guide        | Planned    | Future       |
| API Documentation       | Planned    | Future       |

---

**Made with love for the PyQt community**
