Project Directory Map

This document maps every documentation page to its purpose, organized by functional layer.

Documentation Hierarchy

1. Getting Started → getting-started/installation.md, getting-started/quickstart.md
2. The Big Picture → index.md
3. Architecture & Design → architecture/overview.md → architecture/components.md → architecture/threading.md → architecture/data-flow.md
4. Configuration → configuration/variables.md
5. Troubleshooting → troubleshooting/common-issues.md

Detailed File Index

File	Purpose	Description
index.md	Landing page	Project overview, problem statement, quick start, documentation map
DIRECTORY_STRUCTURE.md	Site map	This file — navigation guide to all docs
getting-started/installation.md	Setup guide	System dependencies, Python deps, virtual environment, permissions
getting-started/quickstart.md	Quick start	Minimal steps to run the script
architecture/overview.md	System architecture	High-level overview, block diagram, component summary, data flow
architecture/components.md	Component deep-dive	Detailed code walkthrough of every subsystem
architecture/threading.md	Threading model	Thread architecture, shared state, race conditions fixed
architecture/data-flow.md	Lifecycle walkthrough	End-to-end sequence from key press to text injection
configuration/variables.md	Settings reference	All config variables, defaults, and recommendations
troubleshooting/common-issues.md	Problem diagnosis	Symptom-based troubleshooting for common issues

Related

• Back to project home