Added a note about the maximum duration of realtime transcription sessions (3 hours)#105
Added a note about the maximum duration of realtime transcription sessions (3 hours)#105Karamouche wants to merge 1 commit intomainfrom
Conversation
📝 WalkthroughWalkthroughDocumentation updates establishing a 3-hour maximum duration limit for realtime transcription sessions. The constraint is documented across concurrency limits, supported formats, and live STT quickstart sections, with guidance for users to start new sessions for longer events. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Tip Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@chapters/limits-and-specifications/concurrency.mdx`:
- Around line 32-34: Replace the inconsistent "Realtime"/"realtime" heading and
occurrences with the hyphenated form "Real-time" (e.g., change the heading
"Realtime session duration" to "Real-time session duration" and any inline
"realtime" to "real-time") and standardize the sentence ending by replacing
"when approaching the limit" with the phrasing used elsewhere ("before reaching
the limit") so the block under the Real-time session duration heading matches
the terminology and wording in the rest of the docs.
In `@chapters/limits-and-specifications/supported-formats.mdx`:
- Around line 26-27: Replace the inconsistent term "Realtime" with "Real-time"
in the sentence that begins "Realtime session duration" (the bullet describing
the live (realtime) transcription WebSocket session 3-hour limit); update both
the displayed text and the parenthetical "realtime" to "real-time" so the phrase
reads "Real-time session duration" and "(live (real-time) transcription)" to
match the project's terminology and silence the spellcheck warning.
In `@chapters/live-stt/quickstart.mdx`:
- Around line 9-11: Update the Note text to use the hyphenated form "real-time"
for consistency with the rest of the document: locate the Note block containing
the sentence starting "A single realtime transcription session cannot exceed **3
hours**." and change "realtime" to "real-time" so the sentence reads "A single
real-time transcription session cannot exceed **3 hours**."
| - **Realtime session duration** : (all plans) | ||
|
|
||
| A single realtime (live) transcription session cannot exceed **3 hours**. After 3 hours, the session will be terminated. For longer events, start a new session when approaching the limit. |
There was a problem hiding this comment.
Inconsistent terminology: "realtime" vs. "real-time".
The rest of this document (line 29) and the quickstart page title (line 3 of quickstart.mdx) use the hyphenated form "real-time," but lines 32 and 34 introduce "Realtime" / "realtime." The vale spellcheck also flags this. Consider using "Real-time" consistently to match the existing docs.
Also, a minor wording inconsistency: this file says "when approaching the limit" while the other two files say "before reaching the limit." Aligning the phrasing across all three pages would reduce reader confusion.
Suggested fix
-- **Realtime session duration** : (all plans)
+- **Real-time session duration** : (all plans)
- A single realtime (live) transcription session cannot exceed **3 hours**. After 3 hours, the session will be terminated. For longer events, start a new session when approaching the limit.
+ A single real-time (live) transcription session cannot exceed **3 hours**. After 3 hours, the session will be terminated. For longer events, start a new session before reaching the limit.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Realtime session duration** : (all plans) | |
| A single realtime (live) transcription session cannot exceed **3 hours**. After 3 hours, the session will be terminated. For longer events, start a new session when approaching the limit. | |
| - **Real-time session duration** : (all plans) | |
| A single real-time (live) transcription session cannot exceed **3 hours**. After 3 hours, the session will be terminated. For longer events, start a new session before reaching the limit. |
🧰 Tools
🪛 GitHub Check: Mintlify Validation (gladia-95) - vale-spellcheck
[warning] 32-32: chapters/limits-and-specifications/concurrency.mdx#L32
Did you really mean 'Realtime'?
[warning] 34-34: chapters/limits-and-specifications/concurrency.mdx#L34
Did you really mean 'realtime'?
🤖 Prompt for AI Agents
In `@chapters/limits-and-specifications/concurrency.mdx` around lines 32 - 34,
Replace the inconsistent "Realtime"/"realtime" heading and occurrences with the
hyphenated form "Real-time" (e.g., change the heading "Realtime session
duration" to "Real-time session duration" and any inline "realtime" to
"real-time") and standardize the sentence ending by replacing "when approaching
the limit" with the phrasing used elsewhere ("before reaching the limit") so the
block under the Real-time session duration heading matches the terminology and
wording in the rest of the docs.
| - **Realtime session duration**: For [live (realtime) transcription](/chapters/live-stt/quickstart), a single WebSocket session cannot exceed **3 hours**. The session will be terminated after 3 hours; for longer events, start a new session before reaching the limit. | ||
|
|
There was a problem hiding this comment.
Same terminology nit: "Realtime" → "Real-time".
Same issue as in concurrency.mdx — use "Real-time" to stay consistent with the rest of the docs and silence the vale spellcheck warning.
Suggested fix
-- **Realtime session duration**: For [live (realtime) transcription](/chapters/live-stt/quickstart), a single WebSocket session cannot exceed **3 hours**. The session will be terminated after 3 hours; for longer events, start a new session before reaching the limit.
+- **Real-time session duration**: For [live (real-time) transcription](/chapters/live-stt/quickstart), a single WebSocket session cannot exceed **3 hours**. The session will be terminated after 3 hours; for longer events, start a new session before reaching the limit.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **Realtime session duration**: For [live (realtime) transcription](/chapters/live-stt/quickstart), a single WebSocket session cannot exceed **3 hours**. The session will be terminated after 3 hours; for longer events, start a new session before reaching the limit. | |
| - **Real-time session duration**: For [live (real-time) transcription](/chapters/live-stt/quickstart), a single WebSocket session cannot exceed **3 hours**. The session will be terminated after 3 hours; for longer events, start a new session before reaching the limit. |
🧰 Tools
🪛 GitHub Check: Mintlify Validation (gladia-95) - vale-spellcheck
[warning] 26-26: chapters/limits-and-specifications/supported-formats.mdx#L26
Did you really mean 'Realtime'?
🤖 Prompt for AI Agents
In `@chapters/limits-and-specifications/supported-formats.mdx` around lines 26 -
27, Replace the inconsistent term "Realtime" with "Real-time" in the sentence
that begins "Realtime session duration" (the bullet describing the live
(realtime) transcription WebSocket session 3-hour limit); update both the
displayed text and the parenthetical "realtime" to "real-time" so the phrase
reads "Real-time session duration" and "(live (real-time) transcription)" to
match the project's terminology and silence the spellcheck warning.
| <Note> | ||
| A single realtime transcription session cannot exceed **3 hours**. For longer events, start a new session before reaching the limit. See [Concurrency and rate limits](/chapters/limits-and-specifications/concurrency) and [Supported files & duration](/chapters/limits-and-specifications/supported-formats) for details. | ||
| </Note> |
There was a problem hiding this comment.
Good placement and cross-referencing.
The note is well-positioned at the top of the quickstart for high visibility, and the links to the limits pages are helpful.
One nit for consistency: line 3 of this very file says "Real-time speech-to-text" but line 10 uses "realtime." Prefer the hyphenated form here as well.
Suggested fix
<Note>
-A single realtime transcription session cannot exceed **3 hours**. For longer events, start a new session before reaching the limit. See [Concurrency and rate limits](/chapters/limits-and-specifications/concurrency) and [Supported files & duration](/chapters/limits-and-specifications/supported-formats) for details.
+A single real-time transcription session cannot exceed **3 hours**. For longer events, start a new session before reaching the limit. See [Concurrency and rate limits](/chapters/limits-and-specifications/concurrency) and [Supported files & duration](/chapters/limits-and-specifications/supported-formats) for details.
</Note>📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <Note> | |
| A single realtime transcription session cannot exceed **3 hours**. For longer events, start a new session before reaching the limit. See [Concurrency and rate limits](/chapters/limits-and-specifications/concurrency) and [Supported files & duration](/chapters/limits-and-specifications/supported-formats) for details. | |
| </Note> | |
| <Note> | |
| A single real-time transcription session cannot exceed **3 hours**. For longer events, start a new session before reaching the limit. See [Concurrency and rate limits](/chapters/limits-and-specifications/concurrency) and [Supported files & duration](/chapters/limits-and-specifications/supported-formats) for details. | |
| </Note> |
🤖 Prompt for AI Agents
In `@chapters/live-stt/quickstart.mdx` around lines 9 - 11, Update the Note text
to use the hyphenated form "real-time" for consistency with the rest of the
document: locate the Note block containing the sentence starting "A single
realtime transcription session cannot exceed **3 hours**." and change "realtime"
to "real-time" so the sentence reads "A single real-time transcription session
cannot exceed **3 hours**."
1 participant
Summary by CodeRabbit