Skip to content

TQPro Documentation

Welcome to the TQPro (TourLinq Professional) documentation. TQPro is a travel and tourism management platform providing unified entity management for integrating with various backend systems.

Documentation Sections

Section Description
Architecture System architecture overview and codebase analysis
User Guide End-user documentation for TripMaker, Cruises, Visa, and Groups
API Reference Complete REST API specification for all endpoints
Developer Guide Getting started, entity framework, frontend, plugins, and code quality
Feature Specs Requirements, use cases, and implementation plans by feature area
Operations Infrastructure, deployment, build/CI, scalability, and observability

Building the Documentation

# Install MkDocs (one-time, using a virtual environment)
python3 -m venv doc/.venv
doc/.venv/bin/pip install mkdocs mkdocs-material

# Build static site (from project root)
doc/.venv/bin/mkdocs build

# Preview locally
doc/.venv/bin/mkdocs serve
# Open http://localhost:8000

The mkdocs.yml config is at the project root. The generated site is output to build/site/ (git-ignored).