# GhostHub Documentation

Start here if you are new to the project.

## I Want To Use GhostHub

- [Quick Start](QUICK_START.md): pick the fastest path for your setup.
- [Flash The GhostHub Image](FLASH_GHOSTHUB_IMAGE.md): fresh SD card setup with the ready-to-flash GhostHub image.
- [DIY Install](DIY_INSTALL.md): official Raspberry Pi OS image, Imager settings, GitHub release installer, and local source deploy CLI.
- [User Guide](HOW_TO_USE_GHOSTHUB.md): layouts, uploading, casting, sync, chat, tunnels, and admin settings.

## I Want To Contribute

- [Contributing](../CONTRIBUTING.md): local setup, validation, backend/frontend rules, and PR expectations.
- [Architecture](ARCHITECTURE.md): how the backend, services, controllers, frontend modules, storage, and runtime pieces fit together.
- [Design Language](DESIGN_LANGUAGE.md): visual and interaction guidance for UI work.
- [Tests](../tests/README.md): Python and JavaScript test workflow.

## I Want To Release Or Validate

- [Release Process](RELEASES.md): versioning, GitHub Releases, release assets, and smoke tests.
- [Manual QA](MANUAL_QA_CHECKLIST.md): human validation on Raspberry Pi hardware.
- [Stress Tests](../stress_tests/README.md): hardware-oriented validation scripts for storage, upload, network, WebSocket, and stability behavior.

## I Want Remote Access

- [Secure Mesh Quick Start](MESH_QUICK_START.md): Headscale/Tailscale setup.
- [Secure Mesh Troubleshooting](SECURE_MESH_TROUBLESHOOTING.md): diagnostics, logs, reset steps, and expected runtime behavior.

## Project Metadata

- [Security Policy](../SECURITY.md)
- [Third-Party Licenses](THIRD_PARTY_LICENSES.md)