rob
/
live-two-way-chat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
live-two-way-chat/CLAUDE.md

1.2 KiB
Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

Live Two-Way Chat - Real-time conversational AI with natural speech flow

Development Commands

# Install for development
pip install -e ".[dev]"

# Run tests
pytest

# Run a single test
pytest tests/test_file.py::test_name

Architecture

TODO: Describe the project architecture

Key Modules

TODO: List key modules and their purposes

Key Paths

  • Source code: src/live-two-way-chat/
  • Tests: tests/
  • Documentation: docs/ (symlink to project-docs)

Documentation

Documentation for this project lives in the centralized docs system:

  • Source: ~/PycharmProjects/project-docs/docs/projects/live-two-way-chat/
  • Public URL: https://pages.brrd.tech/rob/live-two-way-chat/

When updating documentation:

  1. Edit files in docs/ (the symlink) or the full path above
  2. Use public: true frontmatter for public-facing docs
  3. Use <!-- PRIVATE_START --> / <!-- PRIVATE_END --> to hide sections
  4. Run ~/PycharmProjects/project-docs/scripts/build-public-docs.sh live-two-way-chat --deploy to publish

Do NOT create documentation files directly in this repository.