Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update openai-edge-tts-integration.md #251

Merged
merged 4 commits into from
Oct 27, 2024
Merged

Conversation

travisvn
Copy link
Contributor

Documentation Update for OpenAI Edge TTS Integration 📚✨

Summary

This PR enhances the integration page for OpenAI Edge TTS in the Open WebUI docs by implementing several changes to improve clarity, user experience, and setup guidance:

  • Added emojis to section headers to improve readability and create a more engaging experience. 🎨📝
  • Expanded "Quick Environment Config" with sample docker run commands, formatted with one -e flag per line for easy environment setup. 🛠️📦
  • Updated endpoint methods to provide clearer instructions on interacting with the API. 🌐🚀
  • Added a friendly reminder to star the repository if users find the project helpful. ⭐😉

Details

  • The documentation now includes a better layout with improved visual elements to guide users through the setup process.
  • The "Quick Environment Config" section offers a clear example of how to define environment variables when running the Docker container.
  • Endpoint methods have been refined to ensure users can successfully call the APIs with confidence.
  • A playful request for users to support the project by starring the repo is now part of the doc updates.

Feel free to review and let me know if there are any changes needed!

@travisvn
Copy link
Contributor Author

travisvn commented Oct 20, 2024

Added a fix for the CI workflow error (https://github.com/open-webui/docs/actions/runs/11428996721/job/31794873458)

Prettier was causing the verification to fail due to an unrelated file.

Ran the appropriate command and the adjustment was made (adding a new line to the end of the __category__.json file), and now the Prettier check passes 👍

@travisvn
Copy link
Contributor Author

Updated with link to page where the user can browse the available voices

  • Filter by Country, Language, Gender
  • Play sample of voice
  • Quick copy to clipboard for selection

@travisvn
Copy link
Contributor Author

Adding @tjbck to get some traction on this (apologies for the nag!)

@tjbck
Copy link
Contributor

tjbck commented Oct 27, 2024

Thanks!

@tjbck tjbck merged commit 1045cb6 into open-webui:main Oct 27, 2024
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.

2 participants