claude-hud/docs/README.md

Documentation

Start here for a map of the project docs.

Getting Started

• ../README.md for install + quickstart
• ../TROUBLESHOOTING.md for common setup issues
• FAQ.md for common questions

Architecture

• ARCHITECTURE.md for the data flow and component map
• ../CLAUDE.md for contributor-focused technical details
• adr/ for architecture decisions
• API.md for the HUD event contract
• THREAT_MODEL.md for local file and event stream risks

Development

• ../CONTRIBUTING.md for setup, tests, and contribution guidelines
• CHANGELOG.md for release notes
• RELEASING.md for the release workflow

LLM Helpers

• LLM.md for the copy-paste summary block