Update logo for Speech-to-Phrase #3925
Conversation
📝 WalkthroughWalkthroughThis pull request updates the documentation and configuration for the Speech to Phrase Home Assistant add-on. The documentation now includes a new section called "Custom sentences," which explains how users can add custom sentence files, lists supported languages, and provides a hyperlink to the corresponding README section. Additionally, the configuration file has been updated to change the add-on’s name capitalization from "speech-to-phrase" to "Speech-to-Phrase." No functional code or control flow has been modified. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
speech_to_phrase/DOCS.md (1)
37-42: Use dashes for unordered lists.Replace asterisks with dashes to maintain consistent list style:
-* `en` - English -* `fr` - French -* `de` - German -* `nl` - Dutch -* `es` - Spanish -* `it` - Italian +- `en` - English +- `fr` - French +- `de` - German +- `nl` - Dutch +- `es` - Spanish +- `it` - Italian🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
37-37: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
38-38: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
39-39: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
40-40: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
41-41: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
42-42: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
speech_to_phrase/logo.pngis excluded by!**/*.png
📒 Files selected for processing (2)
speech_to_phrase/DOCS.md(2 hunks)speech_to_phrase/config.yaml(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- speech_to_phrase/config.yaml
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in doc...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
speech_to_phrase/DOCS.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - I...
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
speech_to_phrase/DOCS.md
`*/**(html|markdown|md)`: - Be brief in your replies and don...
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
speech_to_phrase/DOCS.md
`*/**(html|markdown|md)`: - Use sentence-style capitalizatio...
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
speech_to_phrase/DOCS.md
`*/**(html|markdown|md)`: do not comment on HTML used for ic...
*/**(html|markdown|md): do not comment on HTML used for icons
speech_to_phrase/DOCS.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for emb...
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
speech_to_phrase/DOCS.md
🪛 markdownlint-cli2 (0.17.2)
speech_to_phrase/DOCS.md
37-37: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
38-38: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
39-39: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
40-40: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
41-41: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
42-42: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Build amd64 speech_to_phrase add-on
- GitHub Check: Build aarch64 speech_to_phrase add-on
🔇 Additional comments (3)
speech_to_phrase/DOCS.md (3)
1-65: PR objectives mention logo update but no logo changes found.The PR objectives indicate this is for updating the logo, but the changes in this file are focused on documentation updates for custom sentences.
Likely an incorrect or invalid review comment.
🧰 Tools
🪛 LanguageTool
[misspelling] ~54-~54: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...ssistant][reddit] In case you've found an bug, please [open an issue on our GitHu...(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
37-37: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
38-38: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
39-39: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
40-40: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
41-41: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
42-42: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
60-60: Link and image reference definitions should be needed
Unused link or image reference definition: "repository"(MD053, link-image-reference-definitions)
64-64: Verify the custom sentences link.Ensure the link points to the correct section in the README.
✅ Verification successful
🏁 Script executed:
#!/bin/bash # Description: Verify the custom sentences link target exists curl -s -I "https://github.com/OHF-voice/speech-to-phrase?tab=readme-ov-file#custom-sentences"Length of output: 4632
Custom Sentences Link Verified
- The URL returns a 200 status code.
- A subsequent check confirms that the HTML contains the anchor (e.g.,
id="custom-sentences"), which implies the targeted section exists.
35-35: Verify the custom sentences directory path.Ensure the specified path
/share/speech-to-phrase/custom_sentences/exists and has appropriate permissions.❌ Verification inconclusive
🏁 Script executed:
#!/bin/bash # Description: Verify the custom sentences directory path exists fd -t d "custom_sentences" /share/speech-to-phraseLength of output: 161
Action Required: Manually Verify the Custom Sentences Directory
The
fdcommand indicates that/share/speech-to-phraseis not a directory in the current environment. This absolute path likely refers to a runtime or deployment configuration that isn’t represented in the repository itself. Please manually verify on the target environment that the directory/share/speech-to-phrase/custom_sentences/exists and that it has the proper permissions.
balloob
changed the title
Summary by CodeRabbit
Documentation
Chores