Feature:Pocket-tts intregration & clean up code structure and remove unused code blocks - #4
Merged
Conversation
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
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.
This pull request introduces significant improvements to the developer and user experience for the Readium Speech Server. The most important changes include a rewritten and expanded
README.mdwith comprehensive documentation, a major overhaul of theMakefileto prioritize Docker-based workflows, and enhancements to the Docker build for better model management and first-run experience. Additionally, the API has improved OpenAPI documentation and more robust health checks.Documentation and Developer Experience
README.mdis completely rewritten and expanded, providing a clear overview, quick start guide, API reference, configuration instructions, and development workflow. This makes onboarding and usage much easier for new users and contributors.Makefileis restructured to make Docker the primary development workflow, with new targets for building, testing, linting, formatting, and running the server in Docker. Local (non-Docker) commands are retained as a fallback. [1] [2]Docker and Environment Management
/weightsvolume, permissions are set up for the app user, and the health checkstart-periodis increased to allow for first-run model downloads. The.env.exampleis removed in favor of interactive configuration viamake configure. [1] [2]API and Health Checks
/v1/synthesizeendpoint OpenAPI schema is improved with more realistic examples, support for multiple formats, and clarification on the binary vs. JSON (with boundaries) response. [1] [2] [3]/readyzhealth check now verifies ffmpeg availability and calls each provider鈥檚 health check, returning 503 if any are not ready. [1] [2]Other
These changes collectively make the project easier to set up, run, and contribute to, with a focus on Docker as the default workflow and much better documentation for both users and developers.