docs: clean avatar and tts documentation#9
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Sorry @SweetSophia, you have reached your weekly rate limit of 500000 diff characters.
Please try again later or upgrade to continue using Sourcery
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in AVATAR.md and TTS.md to align with recent feature updates and improve pathing. Key changes include replacing absolute local paths with relative project paths, documenting the new local asset upload system for character avatars, and centralizing video detection logic. The TTS.md file was also updated to reflect that binary storage is now utilized for character assets and to provide a more neutral summary of the current lack of TTS integration. A review comment correctly identified that the line numbers for the CharacterAvatar component in the documentation were outdated and provided a suggestion for correction.
| ## Main Avatar Component: CharacterAvatar | ||
|
|
||
| **File:** `/home/niya/github/OpenRoom/apps/webuiapps/src/components/ChatPanel/ChatSubComponents.tsx` (lines 92-198) | ||
| **File:** `apps/webuiapps/src/components/ChatPanel/ChatSubComponents.tsx` (lines 92-198) |
There was a problem hiding this comment.
The line numbers for the CharacterAvatar component are outdated. Following the recent updates to ChatSubComponents.tsx (which added asset resolution and error handling), the component and its associated types now span from line 92 to line 251.
| **File:** `apps/webuiapps/src/components/ChatPanel/ChatSubComponents.tsx` (lines 92-198) | |
| **File:** `apps/webuiapps/src/components/ChatPanel/ChatSubComponents.tsx` (lines 92-251) |
There was a problem hiding this comment.
Pull request overview
This PR refreshes internal developer documentation for avatars and TTS by removing machine-local absolute paths, updating avatar docs to reflect the current local-asset upload flow, and reframing the TTS doc as maintained integration notes.
Changes:
- Replace absolute workspace paths in
AVATAR.mdwith repo-relative paths and update the CharacterPanel/avatar docs to include local uploads. - Update
TTS.mdframing/summary and refreshputBinaryFile“current usage” notes to include character asset uploads.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
TTS.md |
Reframes the document as integration notes and updates storage usage notes (now includes character asset uploads). |
AVATAR.md |
Cleans path references and updates avatar/CharacterPanel documentation to reflect URL + local upload support. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## Main Avatar Component: CharacterAvatar | ||
|
|
||
| **File:** `/home/niya/github/OpenRoom/apps/webuiapps/src/components/ChatPanel/ChatSubComponents.tsx` (lines 92-198) | ||
| **File:** `apps/webuiapps/src/components/ChatPanel/ChatSubComponents.tsx` (lines 92-198) |
|
|
||
| ``` | ||
| User pastes URL → emotionImages[emotion] = url | ||
| User pastes URL or uploads asset → emotionImages[emotion] or emotionVideos[emotion] = path/url |
| **Current Usage:** Called from `imageGenTools.ts` to save generated images and from `characterAssetUpload.ts` to save uploaded character images/videos. | ||
|
|
||
| **Relevance to TTS:** This is the **exact storage mechanism** a TTS system would use to save generated audio files (e.g., `audio/mp3`, `audio/wav`). No code changes needed to the storage layer — it is already capable of persisting arbitrary binary data. |
![kilo-code-bot[bot]](https://avatars.githubusercontent.com/in/2193792?s=60&v=4){kind=small}
| ## Emotion Resolution Algorithm | ||
|
|
||
| **File:** `/home/niya/github/OpenRoom/apps/webuiapps/src/lib/characterManager.ts` (lines 316-368) | ||
| **File:** `apps/webuiapps/src/lib/characterManager.ts` (lines 316-368) |
There was a problem hiding this comment.
🔥 The Roast: You scrubbed every /home/niya/github/OpenRoom/ path like you were erasing a crime scene, but you left the line numbers untouched like fingerprints on the doorknob. resolveEmotionMedia starts at line 319, not 316. And since clearEmotionVideoCache lives at 360–368, that range is pretending to be one contiguous block when it's actually a dysfunctional roommate situation with a gap in between.
🩹 The Fix: Update to (lines 319–368) — or better yet, drop line numbers entirely and let readers use grep like the adults they are.
📏 Severity: suggestion
Code Review Roast 🔥Verdict: No New Issues in Incremental Diff | Recommendation: Merge (already merged) Overview
Previously Reported Issues — Status Update
Out-of-Diff Issues (Cannot Comment Inline)
🏆 Best part: You actually fixed the doc line numbers. I'm as surprised as you are. 💀 Worst part: TTS.md line 164 is still out here living its best life, pretending the video element lives at lines 171–182 when it clearly moved to 222–234. Documentation debt is like that one gym membership you keep meaning to cancel. 📊 Overall: Like watching someone finally organize their junk drawer. It was all useful stuff, just in the wrong place. The docs now match reality — mostly. Files Reviewed (2 files)
Reviewed by kimi-for-coding · 197,986 tokens |
SweetSophia
force-pushed
the
fix/avatar-accessibility-tests
branch
from
dd1f82d to
0d22b34
Compare
SweetSophia
force-pushed
the
fix/avatar-docs-cleanup
branch
from
803e877 to
9d26502
Compare
SweetSophia
force-pushed
the
fix/avatar-accessibility-tests
branch
from
0d22b34 to
f006444
Compare
SweetSophia
force-pushed
the
fix/avatar-docs-cleanup
branch
from
9d26502 to
d58dda3
Compare
* test: cover avatar asset editor flow * test: address avatar asset e2e review feedback * test: clean up isolated e2e server home
* docs: clean avatar and tts documentation * test: cover avatar asset editor flow (#10) * test: cover avatar asset editor flow * test: address avatar asset e2e review feedback * test: clean up isolated e2e server home * docs: fix outdated line numbers and storage description
* fix: stage character asset mutations * fix: stream character assets for display * fix: improve avatar asset accessibility * docs: clean avatar and tts documentation (#9) * docs: clean avatar and tts documentation * test: cover avatar asset editor flow (#10) * test: cover avatar asset editor flow * test: address avatar asset e2e review feedback * test: clean up isolated e2e server home * docs: fix outdated line numbers and storage description
Summary
Validation