Update AGENTS.md to match current codebase#379
Open
rymalia wants to merge 1 commit into
Open
Conversation
- Correct README translation count from 10 to 13 (add th, tr, vi) - Reorganize Project Structure into capability groups and document all previously missing modules, including WhisperASR, Fish Audio S2 Pro, Indic-Mio, Audio2Face-3D, and the benchmark targets - Fix Testing section: make test is unit-only; full E2E suite is swift test --disable-sandbox; add single-test invocation - Document the speech-server, asr-bench, vad-bench, and diarization-bench binaries - Note CSpeechCore is a pre-built XCFramework from soniqo/speech-core CLAUDE.md and CODEX.md pick up the changes via symlink.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
AGENTS.md had drifted well behind the codebase — it documented ~14 modules
while the package now has 38 source targets. This brings it fully up to date:
groups (ASR, TTS, Speech-to-Speech & Translation, Audio Processing, Music
Generation, Avatar, On-Device LLM, Infrastructure) and documented every
Sources/target, including the recent WhisperASR, Fish Audio S2 Pro,Indic-Mio, Audio2Face-3D, and benchmark additions
README_th.md,README_tr.md,README_vi.md) in both places it appearssuites showed
make test—make testis unit-only (what CI runs), thefull E2E suite is
swift test --disable-sandbox; added the single-testinvocation
speech-server(Hummingbird HTTP + WebSocket),asr-bench,vad-bench, anddiarization-benchCSpeechCoreis a pre-built XCFrameworkfrom
soniqo/speech-coreand cannot be modified in this repoCLAUDE.mdandCODEX.mdpick up all changes via symlink.Regression risk
None at runtime — documentation only, single file. The recently merged
AGENTS.md additions (Communication Style, docs-scoping rule, skills symlink
note,
/review-prentry) are all preserved.Tests
Not applicable (docs-only change). Verified every directory under
Sources/now appears in the Project Structure list, and cross-checked binary names
against
Package.swift.