Skip to content

Clarify Reson8 language fallback docs#85

Merged
SeoFood merged 1 commit into
mainfrom
seofood/fix-reson8-language-docs
May 29, 2026
Merged

Clarify Reson8 language fallback docs#85
SeoFood merged 1 commit into
mainfrom
seofood/fix-reson8-language-docs

Conversation

@SeoFood
Copy link
Copy Markdown
Contributor

@SeoFood SeoFood commented May 29, 2026

Summary

  • Update the Reson8 add-on docs in English and German to match the ordered language fallback shipped for TypeWhisper macOS issue #627.
  • Clarify that Reson8 receives one language: when multiple TypeWhisper languages are selected, TypeWhisper uses the first supported language; with no selected language, Reson8 auto-detects.

Issue context

This is a website documentation follow-up for TypeWhisper/typewhisper-mac#627 and the Reson8 capability correction in TypeWhisper/typewhisper-mac#639. The live Reson8 page still said multiple language hints fall back to unrestricted Reson8 auto-detect, which is no longer accurate for the fixed macOS behavior.

References TypeWhisper/typewhisper-mac#627.
References TypeWhisper/typewhisper-mac#639.

Test plan

  • npm run test:i18n
  • npm run build

Summary by CodeRabbit

  • Documentation
    • Improved Reson8 add-on documentation with clearer language handling explanations. Now explicitly specifies that only a single language is sent to Reson8, the first supported language is automatically selected when multiple are available, and automatic language detection applies when no language is specified. Updated in both English and German versions.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ff9b15ae-9316-43c8-bb83-5e6b90596528

📥 Commits

Reviewing files that changed from the base of the PR and between c9ff8ea and c432339.

📒 Files selected for processing (2)
  • src/content/addons/de/reson8.mdx
  • src/content/addons/en/reson8.mdx

📝 Walkthrough

Walkthrough

Reson8 add-on documentation is updated in both German and English versions to clarify language selection behavior. The Features section and Transcription mode table now consistently describe that a single language is passed to Reson8, with first-supported-language fallback when multiple languages are selected and auto-detection when none are selected.

Changes

Reson8 Language Handling Documentation Clarification

Layer / File(s) Summary
German documentation language handling clarification
src/content/addons/de/reson8.mdx
Updates the Features bullet and Transkription table "Sprache" row to clarify that Reson8 receives a single language: the first supported language when multiple are selected, or auto-detected when no language is selected.
English documentation language handling clarification
src/content/addons/en/reson8.mdx
Updates the Features bullet and Transcription table "Language" row with matching clarification: single language sent to Reson8, first supported language when multiple are selected, and auto-detect when no language is selected.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

A rabbit hops through docs so clear,
Two tongues, one voice the reader hears—
Reson8 gets a language true,
First-supported, or a guess or two. 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: documentation clarification about Reson8's language fallback behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch seofood/fix-reson8-language-docs

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Comment @coderabbitai help to get the list of available commands and usage tips.

@SeoFood SeoFood merged commit 1dc0f78 into main May 29, 2026
2 checks passed
@SeoFood SeoFood deleted the seofood/fix-reson8-language-docs branch May 29, 2026 09:19
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