docs: comprehensive README and architecture cleanup for v0.1.0 - #21
Closed
jatinkrmalik wants to merge 1 commit into
Closed
docs: comprehensive README and architecture cleanup for v0.1.0#21jatinkrmalik wants to merge 1 commit into
jatinkrmalik wants to merge 1 commit into
Conversation
README: - Fix truncated badge line - Use consistent platform naming (VocaLinux/VocaMac/VocaWin) - Remove emojis from cross-platform links, use platform icons - Fix cross-platform table consistency and links - Remove broken PRD.md link - Add SoundManager, scripts/, web/ to project structure - Add Sound Effects to Configuration section - Add build/install/uninstall script docs - Add Known Limitations section - Remove Roadmap (tracked via GitHub Issues now) - Replace Author section with community footer - Remove all em-dashes ARCHITECTURE.md: - Fix duplicate SettingsView in UI layer diagram - Fix bundle.sh -> build.sh reference - Fix incorrect cross-platform claims (WhisperKit/CoreML are Apple-only) - Add SoundManager to module dependency graph - Remove all em-dashes
Member
Author
|
Changes moved to PR #20 |
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.
Final documentation cleanup before v0.1.0 alpha release.
README Fixes
ARCHITECTURE.md Fixes