OpenWhispr Technical Reference for AI Assistants
This document provides comprehensive technical details about the OpenWhispr project architecture for AI assistants working on the codebase.
## Response Style
Keep responses focused, brief
11k4mo agoReviewMountCreate a free account to mount
development builds due to private API keys
- Code signing configured through SharedXcodeSettings for development
- Documentation and technical notes are located in the `Technotes/` folder
## Code Formatting
Prefer idiomatic modern Swift
10k11d agoReviewMountCreate a free account to mount
style, `var` usage, single-change PRs, English-only code, license, and the rest — are documented in [`CONTRIBUTING.md`](CONTRIBUTING.md). Follow those first.
Project-specific additions:
- Do not write comments within
10k5mo agoReviewMountCreate a free account to mount
Omit `id` for new records (auto-assigned)
- Run `normalize_json.py` to pre-assign IDs (optional)
- Document fixes in `.github/fixes-docs/FIX_ _SUMMARY.md` (ONE file per issue)
- When adding states + cities: run JSON→MySQL
9.9k7mo agoReviewMountCreate a free account to mount
specific tests with `#if NET8_0_OR_GREATER`
- Test results: `test-results/ / .trx`
## Documentation
Docusaurus 3 site in `docs/`. Dev server: `cd docs && pnpm start`. See [DOCUMENTATION.md](DOCUMENTATION.md) for full
Steady28 mentions in 2 weeks
No other project uses it yet
9.8k3y agoReviewMountCreate a free account to mount
cache entries; it does not delete build outputs.
## Running Tests
See `tests/README.md` for full documentation. Quick reference:
```bash
# Full test suite (use after builds to verify correctness)
CTEST_PARALLEL_LEVEL
No other project uses it yet
9.8k52d agoReviewMountCreate a free account to mount
exit detection and rate limiting. See [README.md](README.md) for version info, changelog, and user documentation.
## Core Architecture
### Main Scripts
- **ralph_loop.sh** — main autonomous loop that executes Claude Code repeatedly
- **ralph_monitor.sh** — live
9.7k5mo agoReviewMountCreate a free account to mount
addresses_are_incorrect`, not `invalid_email_addresses_message`.
> For complete style rules (imports, formatting, documentation, Compose conventions), see `docs/STYLE_AND_BEST_PRACTICES.md`.
---
## Anti-Patterns
In addition to the Key Principles above, follow these
No other project uses it yet
9.6k6mo agoReviewMountCreate a free account to mount
what tells you. `manualChunks` is equally load-bearing —
each rule encodes a production incident, documented inline.
**Four build-config facts that look like cruft.** Each is argued
9.6k28d agoReviewMountCreate a free account to mount
A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.
Where does it go?
At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.
What should it contain?
Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.
CLAUDE.md or AGENTS.md?
Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.