# 📚 Remote CMD Documentation Center

Welcome to the Remote CMD Documentation Center! This is the complete collection of documentation for using, developing, and maintaining Remote CMD.

> 🌐 **Language:** This documentation center is maintained in English. The Chinese project overview is available in [README.zh-CN.md](../README.zh-CN.md).

## Quick Navigation

### Getting Started

- [Quick Start Tutorial](./tutorial-quickstart.md) - Get up and running in 15 minutes
- [README.zh-CN.md](../README.zh-CN.md) - Project overview and basic usage (Chinese)

### Advanced Learning

- [Advanced Tutorial](./tutorial-advanced.md) - Advanced features and best practices
- [API Reference (auto-generated)](./api/remote_cmd.html) - Complete API reference (generated by pdoc)
- [API Usage Guide](./API.md) - Class/method usage examples and explanations
- [Architecture](./architecture.md) - System architecture and design decisions

### Development and Contribution

- [Development Guide](./DEVELOPMENT.md) - How to set up the dev environment
- [Contributing Guide](../CONTRIBUTING.md) - How to contribute code
- [Changelog](../CHANGELOG.md) - Version history

### Support and Troubleshooting

- [Troubleshooting Guide](./TROUBLESHOOTING.md) - Frequently asked questions
- [Security Policy](../SECURITY.md) - Security-related information

## Documentation Structure

```
docs/
├── README.md                 # This file (documentation center home)
├── architecture.md           # System architecture documentation
├── tutorial-quickstart.md    # Quick start tutorial
├── tutorial-advanced.md      # Advanced usage tutorial
├── DEVELOPMENT.md            # Development guide
├── API.md                    # API usage guide (examples + explanations)
├── TROUBLESHOOTING.md        # Troubleshooting guide
└── api/                      # Complete API reference auto-generated by pdoc
```

## Recommended Reading Order

### New Users

1. [README.md](../README.md) - Understand the project
2. [Quick Start Tutorial](./tutorial-quickstart.md) - Get started quickly
3. [API Usage Guide](./API.md) - Learn the API

### Developers

1. [Development Guide](./DEVELOPMENT.md) - Set up the dev environment
2. [Architecture](./architecture.md) - Understand the architecture
3. [API Reference (auto-generated)](./api/remote_cmd.html) - Dive into API details

### Advanced Users

1. [Advanced Tutorial](./tutorial-advanced.md) - Master advanced features
2. [Troubleshooting Guide](./TROUBLESHOOTING.md) - Solve common problems

## Getting Help

If you still have questions after reading the documentation, follow this order:

1. Check the [Troubleshooting Guide](./TROUBLESHOOTING.md)
2. Search [GitHub Issues](https://github.com/Vae-Scrooge/remote-cmd/issues)
3. Open a new Issue

## Contributing to Documentation

Found an error in the docs or want to add content? Pull requests are welcome!

See the "Improving Documentation" section in [CONTRIBUTING.md](../CONTRIBUTING.md).

---

**Happy using!** 🚀