Skip to content

docs: Sync ROADMAP.md, README.md, and INSTALL guides with recent code changes#20

Draft
google-labs-jules[bot] wants to merge 1 commit intomainfrom
fix-documentation-sync-15316061318408818040
Draft

docs: Sync ROADMAP.md, README.md, and INSTALL guides with recent code changes#20
google-labs-jules[bot] wants to merge 1 commit intomainfrom
fix-documentation-sync-15316061318408818040

Conversation

@google-labs-jules
Copy link
Copy Markdown
Contributor

The documentation, Mermaid schemas, and installation instructions were lagging behind the recent changes in the codebase. Specifically, the number of supported languages has increased to 13, and the phone prefixes detection rules have expanded to 54. The speech_timeout was updated in the code to 1s. Additionally, recent optimizations, such as switching to gpt-4o-mini, reducing max_tokens, and adding Groq support, were implemented in the code but had not been moved to the "Completed" section of the roadmap.

This commit brings the documentation files up to speed with these actualities:

  • ROADMAP.md is updated to reflect accurately what is already completed, adjusts the recorded latency times due to the 1s speech_timeout, and updates the pre-warming task count.
  • README.md now correctly details 54 prefixes and 13+ languages.
  • INSTALL_EN.md and INSTALL_PL.md have their architecture diagrams synchronized with the 13+ language support update.

PR created automatically by Jules for task 15316061318408818040 started by @dzaczek

… changes

Updates documentation files to reflect the latest codebase state:
- ROADMAP.md: Moves completed short/medium tasks (gpt-4o-mini switch, max_tokens reduction, Groq LLaMA 3 support) to the "Completed" section.
- ROADMAP.md: Updates latency breakdown to reflect 1.0s `speech_timeout` and modifies related impact/descriptions.
- ROADMAP.md: Adjusts the short-term goal to pre-warm cache for 13 languages instead of 8.
- README.md: Updates Mermaid diagram and labels to reflect 13+ languages and 54 phone prefix detections instead of 11+ languages and 52 prefixes.
- docs/INSTALL_EN.md & docs/INSTALL_PL.md: Updates system architecture diagrams from 11+ languages to 13+ languages.
@google-labs-jules
Copy link
Copy Markdown
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

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.

0 participants