# PyPTV Documentation Index

Welcome to the PyPTV documentation! This index provides an organized overview of all available guides and resources. Use this page as your starting point for learning, troubleshooting, and reference.

## Getting Started
- [Installation Guide](installation.md)
- [Windows Installation Guide](windows-installation.md)
- [Quick Start Guide](quick-start.md)

## Core Usage
- [Running the GUI](running-gui.md)
- [YAML Parameters Reference](yaml-parameters.md)
- [Parameter Migration Guide](parameter-migration.md)
- [Calibration Guide](calibration.md)
- [Examples and Workflows](examples.md)

## Advanced Features
- [Splitter Mode Guide](splitter-mode.md)
- [Plugins System Guide](plugins.md)


## Additional Resources
- [Test Cavity Example](examples.md#test-cavity)
- [Parameter Migration FAQ](parameter-migration.md#common-migration-issues)

---

**How to use this documentation:**
- Click any link above to jump to the relevant guide.
- Use your browser's search to find keywords or topics.
- For troubleshooting, check the FAQ sections in each guide.
- For community help, visit [GitHub Issues](https://github.com/openptv/pyptv/issues) or [Discussions](https://github.com/openptv/pyptv/discussions).


## Video Tutorials

Explore our YouTube video tutorials for step-by-step demonstrations:

- [PyPTV installation on Linux](https://youtu.be/mlpaJ64t3Kw)
- [Installation on Windows](https://youtu.be/kWREmrGa7Z8)
- [Using Splitter Mode](https://youtu.be/FYZGZlL1yqs?si=4shcdja9CK3SEXGJ)
- [Using rembg plugin](https://youtu.be/vzlX2dIkhjw)

Find more videos on our [PyPTV YouTube Channel](https://www.youtube.com/@openptv1113).

---

*Documentation last updated: August 2025 for PyPTV 2025*
