Skip to content

Feature:Pocket-tts intregration & clean up code structure and remove unused code blocks - #4

Merged
ronibhakta1 merged 1 commit into
readium:mainfrom
ronibhakta1:feature/pocket-tts
Jun 30, 2026
Merged

Feature:Pocket-tts intregration & clean up code structure and remove unused code blocks#4
ronibhakta1 merged 1 commit into
readium:mainfrom
ronibhakta1:feature/pocket-tts

Conversation

@ronibhakta1

Copy link
Copy Markdown
Contributor

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.md with comprehensive documentation, a major overhaul of the Makefile to 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.md is 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.
  • The Makefile is 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

  • The Docker build process is improved: model weights are now downloaded to a persistent /weights volume, permissions are set up for the app user, and the health check start-period is increased to allow for first-run model downloads. The .env.example is removed in favor of interactive configuration via make configure. [1] [2]
  • The Docker image now copies test files for containerized test runs and uses a dedicated entrypoint script for startup.

API and Health Checks

  • The /v1/synthesize endpoint 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]
  • The /readyz health check now verifies ffmpeg availability and calls each provider鈥檚 health check, returning 503 if any are not ready. [1] [2]

Other

  • Minor code cleanups and dependency annotation improvements.

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.

@ronibhakta1
ronibhakta1 merged commit 914fc19 into readium:main Jun 30, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant