Skip to content

Conversation

@shanto12
Copy link

@shanto12 shanto12 commented Oct 26, 2025

Summary

This PR fixes two documentation issues in README.md:

1. Flutter TTS macOS Mirror Link Targets (Lines 177-178, 525, 527)

The Chinese mirror links (中国用户 column) for macOS platforms in the Flutter TTS table were swapped:

  • macOS (x64) row was pointing to the arm64 mirror page
  • macOS (arm64) row was pointing to the x64 mirror page

This affected both the table references and their corresponding URL definitions at the bottom of the file.

Changed lines:

  • Line 177: [点此][flutter-tts-macos-arm64-cn][点此][flutter-tts-macos-x64-cn]
  • Line 178: [点此][flutter-tts-macos-x64-cn][点此][flutter-tts-macos-arm64-cn]
  • Line 525: URL for flutter-tts-macos-arm64-cn corrected to point to tts-macos-arm64-cn.html
  • Line 527: URL for flutter-tts-macos-x64-cn corrected to point to tts-macos-x64-cn.html

2. Speech Enhancement Link Typo (Line 575)

Fixed typo in the speech enhancement documentation link:

  • Before: speech-enhancment (missing 'e')
  • After: speech-enhancement

Changed line:

  • Line 575: https://k2-fsa.github.io/sherpa/onnx/speech-enhancment/index.htmlhttps://k2-fsa.github.io/sherpa/onnx/speech-enhancement/index.html

Rationale

These fixes ensure that:

  1. Chinese users clicking on macOS Flutter TTS links are directed to the correct architecture-specific mirror pages
  2. The speech enhancement documentation link works correctly (the typo would result in a 404 error)

Testing

Verified that all changed link references match their corresponding URL definitions and follow the correct naming pattern for the documentation site structure.

Summary by CodeRabbit

Documentation

  • Corrected macOS TTS download links for x64 and arm64 architectures to reference proper language-specific pages
  • Updated corresponding Android and Flutter app links to reflect macOS corrections
  • Fixed typo in speech enhancement reference

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Oct 26, 2025
@coderabbitai
Copy link

coderabbitai bot commented Oct 26, 2025

Walkthrough

README.md updated with corrected macOS TTS links pointing to language-specific CN pages (x64-cn and arm64-cn), reassigned CN targets in Flutter APPs and Android APK sections, and fixed typo in se-url reference from "speech-enhancment" to "speech-enhancement".

Changes

Cohort / File(s) Summary
Documentation fixes
README.md
Corrected macOS (x64) and macOS (arm64) TTS entry links to point to correct language-specific CN pages; reassigned corresponding CN targets in pre-built Flutter APPs and Android APK sections; fixed typo in se-url reference

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Links were tangled, typos did hide,
But now they're fixed with rabbit pride!
From speech-enhancment to enhancement true,
macOS paths now point to you-know-who!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "docs: fix Flutter TTS macOS mirror link targets; fix speech-enhanceme…" accurately reflects the main changes in the changeset. It clearly identifies the two primary fixes: the Flutter TTS macOS mirror link corrections (addressing the swapped x64/arm64 link references) and the speech-enhancement typo fix. The title is specific, concise, and uses appropriate documentation prefix notation, making it clear to anyone reviewing the history that these are targeted documentation URL corrections. The title is fully aligned with the changeset content and does not contain misleading or vague terminology.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4450c83 and 76272a3.

📒 Files selected for processing (1)
  • README.md (4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md

1-1: Headings must start at the beginning of the line

(MD023, heading-start-left)

🔇 Additional comments (3)
README.md (3)

177-178: Link mappings are correct and properly aligned.

The Flutter TTS macOS table entries now correctly reference the architecture-specific Chinese mirror links:

  • macOS (x64) → flutter-tts-macos-x64-cn
  • macOS (arm64) → flutter-tts-macos-arm64-cn

These match the URL definitions at lines 525 and 527 respectively.


525-525: URL definitions follow the correct naming convention.

Both reference definitions use the consistent pattern (tts-macos-{arch}-cn.html):

  • Line 525: flutter-tts-macos-arm64-cntts-macos-arm64-cn.html
  • Line 527: flutter-tts-macos-x64-cntts-macos-x64-cn.html

Also applies to: 527-527


575-575: Speech enhancement typo fixed.

The se-url reference corrected from speech-enhancment to speech-enhancement and now points to the correct documentation path. This prevents 404 errors for Chinese users accessing the speech enhancement documentation.


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.

❤️ Share

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:S This PR changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant