Doc update 2025 #92
Doc update 2025 #92
Conversation
📝 WalkthroughWalkthroughThe pull request introduces new configuration files and updates several documentation files. Two configuration files are added for spell checking settings. The documentation is reorganized with a simplified README, an updated sidebar, a newly added Installation section, and additional sections for Settings, Support, and Usage Tips. The changes focus on clarifying content, refining navigation, and standardizing the layout of information across various markdown files. Changes
Suggested labels
Suggested reviewers
Poem
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: 3
🧹 Nitpick comments (10)
support.md (2)
5-5: Typographical and Punctuation Corrections in Issue Reporting
The bullet point on error reporting has a few issues:
- "GitHib Repository" should be corrected to "GitHub Repository".
- Consider replacing "raise an issue" with "please raise an issue" for a more polite tone.
- Change "try and describe" to "try to describe" for grammatical correctness.
A revised version might read:
- For any errors or bug reports, please raise an issue in the GitHub Repository. Be sure to follow the new issue template and try to describe in as much detail as possible what you were doing when the error occurred. If it is determined that the error is with a third-party plugin, you may be directed to open the issue in the respective plugin author’s repository.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: A comma might be missing here.
Context: ...ollowing ways: - For any errors or bug reports raise an issue in the GitHib Repository...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~5-~5: A verb may be missing.
Context: ...y and describe in as much detail as you can what you were doing when the error occurred....(CAN_WHAT)
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...If it is determined the error is with a third party plugin, you may be directed to open the...(EN_COMPOUND_ADJECTIVE_INTERNAL)
11-19: Formatting and Consistency for Additional Support Channels
The descriptions for Discord and Reddit support channels are well done. To polish the text:
- Consider adding a colon or consistent punctuation after Discord and Reddit (e.g.,
**Discord:**instead of just**Discord**).- Double-check that the list styling is uniform throughout the section.
installation.md (3)
1-4: Installation Section Overview
The "### Installation" header and the introductory paragraph provide clear guidance on the installation methods. Consider using an Oxford comma in the list (e.g., "Winget, Scoop, and Chocolatey") for consistency. Additionally, verify that "GitHub" is consistently capitalised in the text.
13-13: Terminology Consistency for Security Warnings
In the sentence about false positives, hyphenate "third party" to "third-party", and confirm the preferred styling for "antivirus" and "antimalware" (often written as one word).🧰 Tools
🪛 LanguageTool
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...so get false positives from third party anti-virus and anti-malware applications. As above...(EN_COMPOUNDS_ANTI_VIRUS)
15-32: Plugins Section Consistency
The plugins section is informative. A few refinements:
- Hyphenate "third party" to "third-party" for consistency.
- Consider ending the final sentence with a period.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...indow Settings There are also over 200 third party plugins that extend Flow Launcher's fun...(EN_COMPOUND_ADJECTIVE_INTERNAL)
_sidebar.md (1)
8-8: Duplicate Word Check in Bookmark Plugin Link
A static analysis hint flagged a potential repeated word in the Bookmark Plugin link. Although no obvious duplication is visible, please double-check the link text for consistency.🧰 Tools
🪛 LanguageTool
[duplication] ~8-~8: Possible typo: you repeated a word.
Context: ...(/plugin-explorer.md) - Bookmark Plugin - Plugin Development - [*...(ENGLISH_WORD_REPEAT_RULE)
usage-tips.md (4)
1-4: Usage Tips Section – Introduction and Installation Subsection
The introduction under "### Usage Tips" followed by "#### Installation" provides a targeted guide. In the installation bullet:
- Consider splitting long sentences to improve readability.
- Standardise units by writing "250 MB" (with a space) rather than "250mb".
7-8: Abbreviation Formatting in Searching Section
In the "#### Searching" section, ensure that abbreviations such as "e.g." are used correctly. For instance, update "Fuzzy eg.acr" to "Fuzzy, e.g.,acr" to adhere to standard punctuation for abbreviations.🧰 Tools
🪛 LanguageTool
[uncategorized] ~8-~8: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...rgpfor GitKraken Preview. - Fuzzy eg.acrorreafor Acrobat Reader DC. ...(E_G)
13-13: Terminology in Plugins Section
In the Plugins subsection, consider revising "the keyword you are after" to "the keywords you are after" to match the context that multiple keywords might be expected.🧰 Tools
🪛 LanguageTool
[grammar] ~13-~13: Did you mean “keywords”?
Context: ...y typing the first letter or two of the keyword you are after. - The plugin results ord...(CD_OF_THE_NN)
30-30: Correcting Terminology in Settings Restoration
In the instructions on restoring settings, change "all your settings will be setup" to "all your settings will be set up" for proper grammatical usage.🧰 Tools
🪛 LanguageTool
[grammar] ~30-~30: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...tart Flow and all your settings will be setup. One exception, however, is your saved ...(BE_VB_OR_NN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
assets/Flow_settings_launch.pngis excluded by!**/*.pngassets/Flow_settings_launch_right_click.pngis excluded by!**/*.pngassets/Flow_settings_taskbar.pngis excluded by!**/*.pngassets/Flow_smartscreen.pngis excluded by!**/*.png
📒 Files selected for processing (9)
.vscode/settings.json(1 hunks)README.md(1 hunks)_sidebar.md(1 hunks)cspell.json(1 hunks)installation.md(1 hunks)plugin-bookmark.md(1 hunks)settings.md(1 hunks)support.md(1 hunks)usage-tips.md(1 hunks)
✅ Files skipped from review due to trivial changes (4)
- .vscode/settings.json
- plugin-bookmark.md
- settings.md
- cspell.json
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~3-~3: “to the” seems less likely than “to”.
Context: ...ld help familiarise you with how to get to the the settings to customise Flow to your ...
(AI_HYDRA_LEO_CP_TO_THE_TO)
installation.md
[uncategorized] ~11-~11: A comma is probably missing here.
Context: ...aller to run without this warning. Over time we are hoping this becomes a trusted ap...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[typographical] ~11-~11: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...his becomes a trusted app with Microsoft, however this does not mean Flow Launcher is dan...
(HOWEVER_SENTENCE)
[duplication] ~11-~11: Possible typo: you repeated a word.
Context: ...you should be satisfied of the pedigree of of the installation executable. For Flow L...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~11-~11: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...icial repo. Flow Launcher is open source so anyone can download and review the sour...
(COMMA_COMPOUND_SENTENCE_2)
[misspelling] ~13-~13: This word is normally spelled as one.
Context: ...so get false positives from third party anti-virus and anti-malware applications. As above...
(EN_COMPOUNDS_ANTI_VIRUS)
[uncategorized] ~32-~32: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...indow Settings There are also over 200 third party plugins that extend Flow Launcher's fun...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
_sidebar.md
[duplication] ~8-~8: Possible typo: you repeated a word.
Context: ...(/plugin-explorer.md) - Bookmark Plugin - Plugin Development - [*...
(ENGLISH_WORD_REPEAT_RULE)
usage-tips.md
[uncategorized] ~8-~8: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...r gp for GitKraken Preview. - Fuzzy eg. acr or rea for Acrobat Reader DC. ...
(E_G)
[grammar] ~13-~13: Did you mean “keywords”?
Context: ...y typing the first letter or two of the keyword you are after. - The plugin results ord...
(CD_OF_THE_NN)
[style] ~17-~17: The phrase ‘lots of’ might be wordy and overused. Consider using an alternative.
Context: ...icated keyword is because it may return lots of results cluttering the result list. - F...
(A_LOT_OF)
[grammar] ~30-~30: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...tart Flow and all your settings will be setup. One exception, however, is your saved ...
(BE_VB_OR_NN)
support.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ### Support Flow Launcher is an open source project that is updated and maintained ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~5-~5: A comma might be missing here.
Context: ...ollowing ways: - For any errors or bug reports raise an issue in the GitHib Repository...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~5-~5: A verb may be missing.
Context: ...y and describe in as much detail as you can what you were doing when the error occurred....
(CAN_WHAT)
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...If it is determined the error is with a third party plugin, you may be directed to open the...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (6)
support.md (2)
1-4: Section Header and Introduction Clarity
The "### Support" header and the introductory text clearly outline the support avenues. Consider whether you want to consistently use "open-source" (with a hyphen) when used as a modifier before a noun.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ### Support Flow Launcher is an open source project that is updated and maintained ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
7-10: Link Formatting for GitHub Support Channel
The GitHub link is clear. Verify that the indentation and formatting align with the rest of the document’s style (for example, ensuring consistent spacing before the URL).installation.md (3)
5-5: Security Subsection Introduction
The "#### Security" header clearly sets apart the security considerations. No changes are needed here.
7-7: SmartScreen Warning Description
The description regarding the Microsoft Defender SmartScreen warning is comprehensive. Ensure that the language stays precise, and consider adding a note on verifying the download source if it isn’t already emphasized later.
9-9: Image Link Verification
The image markdown for the SmartScreen warning looks correct. Confirm that the image path/assets/Flow_smartscreen.pngis valid in the repository._sidebar.md (1)
1-9: Enhanced Sidebar Navigation Structure
The updated sidebar clearly reorganises the documentation with new links for Installation, Settings, and Support. Confirm that the order reflects the intended navigation flow.🧰 Tools
🪛 LanguageTool
[duplication] ~8-~8: Possible typo: you repeated a word.
Context: ...(/plugin-explorer.md) - Bookmark Plugin - Plugin Development - [*...(ENGLISH_WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (8)
usage-tips.md (8)
3-4: Rephrase for Enhanced Clarity in the Installation Section
Consider rewording the text for improved readability. For example, you might update the content to:Flow is distributed as a self-contained Windows application (compatible with Windows 7 and later), which eliminates the need for separate .NET runtime or framework installations. With support for portable mode, Flow can be run from cloud storage services (like Dropbox); note, however, that the package size is approximately 250 MB due to the bundled .NET components.
This revision streamlines the message while preserving the original details.
5-6: Minor Formatting Note in the Searching Section
There's an extra space between "Search for" and "items" in line 6. Removing it will enhance visual consistency.
15-15: Punctuation Improvement in Reload Instruction
For better clarity, consider adding commas in the sentence. For example:"Press
F5while in the query window, or typereload plugin data, to reload all plugin data."
This small change enhances readability.🧰 Tools
🪛 LanguageTool
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...t list. - PressF5while in the query window or typereload plugin datato reload ...(AI_HYDRA_LEO_MISSING_COMMA)
20-20: Key Naming Consistency for Shell Plugin Commands
Consider capitalizing "Ctrl" (e.g., "Ctrl + Enter") for consistency with other sections.
21-21: Consistent Key Naming Recommended for Plugin URL Access
Similarly, ensure "Ctrl" is capitalized consistently in this instruction as well.
22-22: Suggestion to Simplify the Explorer's Search Explanation
The description for the Search action keyword is informative but a bit lengthy. Consider rephrasing it for brevity. For instance:"Explorer's Search action keyword supports both Path and Index searches, allowing you to search without needing to specify a particular mode. Note that both search methods are disabled by default."
This is optional, but could improve clarity.
31-31: Punctuation Improvement Recommended in Settings Migration Note
Consider adding a comma between "SettingWindowHeight" and "SettingWindowTop" to improve readability. For example:"adjust 'SettingWindowWidth', 'SettingWindowHeight', 'SettingWindowTop' and 'SettingWindowLeft'"
33-41: Remove Excessive Blank Lines
There are multiple consecutive blank lines after the Settings section. Consider removing them to streamline the document’s formatting.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
usage-tips.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
usage-tips.md
[uncategorized] ~15-~15: Possible missing comma found.
Context: ...t list. - Press F5 while in the query window or type reload plugin data to reload ...
(AI_HYDRA_LEO_MISSING_COMMA)
[typographical] ~17-~17: Two consecutive dots
Context: ...of results and avoid cluttering the list.. - For Explorer plugin results, you can ...
(DOUBLE_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: gitStream.cm
- GitHub Check: gitStream.cm
🔇 Additional comments (15)
usage-tips.md (15)
1-2: Header Clarity: "Usage Tips" Section
The main header is clearly defined and sets a good introduction for the document.
7-9: Search Examples are Clear
The examples for acronyms, fuzzy, and single-word searches are well-presented and easy to understand.
10-10: Clear Instructions for Accessing the Context Menu
The explanation on how to access the context menu using either a right-click or the right-arrow key is concise and effective.
12-13: Effective Explanation on Plugin Keywords
The directions for using the?command to display active keywords are straightforward and useful.
14-14: Detailed Plugin Priority Instructions
The detailed explanation of how to prioritize plugin results by adjusting the 'Priority' number provides clear guidance.
16-16: Automatic Plugin Update Explained Well
The note about the Program and Bookmarks plugins automatically detecting changes is clear and helpful.
18-18: Clear Directions for Using the Explorer Plugin
The instructions for usingCtrl + Enterto open a folder directly are precise and easy to follow.
19-19: Comprehensive Guidance for Quick Access via Explorer Plugin
The detailed instructions on how to add frequently used locations to Quick Access are very useful.
23-23: Clear Navigation Instruction
The guidance on usingCtrl + Backspaceto navigate up one directory level is clear and well-stated.
25-25: Settings Section Header is Effective
The header "#### Settings" clearly introduces the settings-related details that follow.
26-26: Introduction to Settings Location is Clear
The opening sentence for the settings section effectively informs the reader what to expect.
27-28: Precise Path Details for Flow’s Settings
The listed paths for roaming and portable configurations are detailed and accurate.
29-29: Straightforward Backup Instructions
The explanation on backing up the UserData folder is clear and actionable.
30-30: Detailed Restore Procedure with a Notable Exception
The restore instructions are well-detailed, and noting the exception for Quick Access is particularly useful.
32-32: Concise Reset to Default Instruction
The reset instructions are succinct and clear.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
installation.md (1)
11-11: Improve Punctuation and Preposition in Warning Description
The warning description would benefit from enhanced punctuation and clearer phrasing. For example, replacing "satisfied of the pedigree" with "satisfied with the pedigree," adding commas after introductory phrases, and placing a comma before "so" can improve readability and precision.Proposed diff for line 11:
-This appears as Flow Launcher has not been downloaded enough times, or users have not flagged this as "safe", for Microsoft to yet allow the installer to run without this warning. Over time we are hoping this becomes a trusted app with Microsoft; however this does not mean Flow Launcher is dangerous or malicious. As you should do with all software, you should be satisfied of the pedigree of the installation executable. For Flow Launcher you should ensure you download from flowlauncher.com, or the official repo. Flow Launcher is open source so anyone can download and review the source code. Any issues or concerns are welcome in the Issues part of the repo. +This appears because Flow Launcher has not been downloaded enough times or flagged as "safe" for Microsoft to automatically allow the installer to run without warnings. Over time, we hope this becomes a trusted app with Microsoft; however, this does not mean Flow Launcher is dangerous or malicious. As with all software, you should be satisfied with the pedigree of the installation executable. For Flow Launcher, ensure you download it from flowlauncher.com or the official repository. Flow Launcher is open source, so anyone can download and review the source code. Any issues or concerns are welcome in the Issues section of the repository.🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: A comma is probably missing here.
Context: ...aller to run without this warning. Over time we are hoping this becomes a trusted ap...(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~11-~11: The preposition “with” seems more likely in this position.
Context: ...h all software, you should be satisfied of the pedigree of the installation execut...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ...f the installation executable. For Flow Launcher you should ensure you download from flo...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...icial repo. Flow Launcher is open source so anyone can download and review the sour...(COMMA_COMPOUND_SENTENCE_2)
support.md (4)
3-3: Enhance Compound Adjective Formatting
Consider hyphenating "open source" to "open-source" in the phrase "open source project" to clearly indicate it functions as a compound adjective modifying "project."-Flow Launcher is an open source project that is updated and maintained by a team of volunteers. +Flow Launcher is an open-source project that is updated and maintained by a team of volunteers.🧰 Tools
🪛 LanguageTool
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ### Support Flow Launcher is an open source project that is updated and maintained ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
5-5: Improve Sentence Clarity and Punctuation
Add a comma after "bug reports" and hyphenate "third party" to "third-party" for better readability. Additionally, consider rephrasing the clause "try to describe in as much detail as you can what you were doing when the error occurred" to improve clarity.- - For any errors or bug reports raise an issue in the GitHub Repository. Please follow the new issue template and try to describe in as much detail as you can what you were doing when the error occurred. If it is determined the error is with a third party plugin, you may be directed to open the issue in the plugin author's repository so they can investigate. + - For any errors or bug reports, raise an issue in the GitHub Repository. Please follow the new issue template and try to provide a detailed description of what you were doing when the error occurred. If it is determined the error is with a third-party plugin, you may be directed to open the issue in the plugin author's repository so they can investigate.🧰 Tools
🪛 LanguageTool
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...ollowing ways: - For any errors or bug reports raise an issue in the GitHub Repository...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~5-~5: A verb may be missing.
Context: ...ry to describe in as much detail as you can what you were doing when the error occurred....(CAN_WHAT)
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...If it is determined the error is with a third party plugin, you may be directed to open the...(EN_COMPOUND_ADJECTIVE_INTERNAL)
7-7: Standardize Platform Name Capitalization
Update "Github" to "GitHub" to ensure consistency with the platform’s official branding.-**Github** +**GitHub**
11-11: Clarify Abbreviations and Terminology
Consider replacing the abbreviation "dev" with "development" and "world-wide" with "worldwide" for improved clarity and consistency in documentation.- For problems, suggestions, hints, tips, help with plugin dev, or just to connect with other Flow Launcher users world-wide, pop in and say hello on + For problems, suggestions, hints, tips, help with plugin development, or just to connect with other Flow Launcher users worldwide, pop in and say hello on
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(1 hunks)installation.md(1 hunks)support.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- README.md
🧰 Additional context used
🪛 LanguageTool
support.md
[uncategorized] ~3-~3: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ### Support Flow Launcher is an open source project that is updated and maintained ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~5-~5: Possible missing comma found.
Context: ...ollowing ways: - For any errors or bug reports raise an issue in the GitHub Repository...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~5-~5: A verb may be missing.
Context: ...ry to describe in as much detail as you can what you were doing when the error occurred....
(CAN_WHAT)
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...If it is determined the error is with a third party plugin, you may be directed to open the...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
installation.md
[uncategorized] ~11-~11: A comma is probably missing here.
Context: ...aller to run without this warning. Over time we are hoping this becomes a trusted ap...
(MISSING_COMMA_AFTER_INTRODUCTORY_PHRASE)
[uncategorized] ~11-~11: The preposition “with” seems more likely in this position.
Context: ...h all software, you should be satisfied of the pedigree of the installation execut...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
[uncategorized] ~11-~11: Possible missing comma found.
Context: ...f the installation executable. For Flow Launcher you should ensure you download from flo...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...icial repo. Flow Launcher is open source so anyone can download and review the sour...
(COMMA_COMPOUND_SENTENCE_2)
🔇 Additional comments (3)
installation.md (3)
1-4: Clear and Informative Installation Header
The installation header and introductory paragraph clearly present the available installation methods. The content is concise and helps set the context for incoming details.
5-10: Well-Structured Security Section Introduction
The "Security" section is clearly marked and introduces the topic with a relevant image, which helps in understanding the context. The initial part of the security explanation is well-organized.
15-33: Well-Organized Plugins Section
The plugins section clearly lists the core plugins provided with Flow Launcher and mentions the availability of over 200 third-party plugins. This layout aids in navigation and sets the user's expectations about the range of functionality.
Updated documentation