Skip to content

Add official channels section to readme#4489

Merged
DavidGBrett merged 1 commit into
devfrom
add-official-channels-section-to-readme
May 25, 2026
Merged

Add official channels section to readme#4489
DavidGBrett merged 1 commit into
devfrom
add-official-channels-section-to-readme

Conversation

@DavidGBrett

@DavidGBrett DavidGBrett commented May 25, 2026

Copy link
Copy Markdown
Contributor

In light of discussions regarding flow-launcher.com

Adds a list of official channels and a warning to be careful of similar looking domains and only use official installation methods

image

Summary by cubic

Adds an “Official Channels” section to the README with trusted links (website, GitHub, Discord, Reddit) and a warning about lookalike domains. Also adds a TOC link to the new section. No code changes.

Summary of changes

  • Changed: Updated the README’s link bar to include “Official Channels.”
  • Added: New “Official Channels” section with links to the website, GitHub org, Discord, and Reddit, plus a warning to use only official install methods.
  • Removed: Nothing.
  • Memory usage: No impact; documentation-only change.
  • Security: Lowers phishing risk by directing users to verified channels; no new risks introduced.
  • Unit tests: None required; documentation-only change.

Release Note
Added a new “Official Channels” section in the README with trusted links so users can find authentic downloads and announcements.

Written for commit 3c09e76. Summary will update on new commits. Review in cubic

@github-actions github-actions Bot added this to the 2.2.0 milestone May 25, 2026
@DavidGBrett DavidGBrett added the Documentation Update required to documentation label May 25, 2026

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@coderabbitai

coderabbitai Bot commented May 25, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

README updated with a new "Official Channels" navigation link in the header and corresponding section listing official community/download sources (website, GitHub org, Discord, Reddit) with a warning to trust only official channels for downloads and announcements.

Changes

Official Channels Section

Layer / File(s) Summary
Official Channels navigation and section
README.md
Top-level navigation anchor link added to README header; new "Official Channels" section created with links to official website, GitHub organization, Discord, and Reddit, accompanied by a trust/safety warning about using only official sources for downloads and announcements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding an official channels section to the README. It is concise, clear, and directly reflects the changeset content.
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.
Description check ✅ Passed The pull request description is clearly related to the changeset, describing the addition of an 'Official Channels' section to the README with specific details about the content added.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-official-channels-section-to-readme

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 53: The separator image tag (<img
src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png"
width="100%">) is missing alt text which triggers MD045; add a meaningful alt
attribute (e.g., alt="section divider" or a description appropriate for the
image) to the <img> element so the tag becomes <img ... alt="..."> to restore
accessibility and satisfy the linter.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4f35e947-517a-448b-af7c-7781883957c1

📥 Commits

Reviewing files that changed from the base of the PR and between 793b66c and 3c09e76.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md

For installation, use the official methods listed below.

<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add alt text to the separator image on Line 53.

This trips MD045 (no-alt-text) and reduces accessibility in rendered docs.

Proposed fix
-<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
+<img alt="Section divider" src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
📝 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.

Suggested change
<img src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
<img alt="Section divider" src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png" width="100%">
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 53-53: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 53, The separator image tag (<img
src="https://user-images.githubusercontent.com/6903107/144858082-8b654daf-60fb-4ee6-89b2-6183b73510d1.png"
width="100%">) is missing alt text which triggers MD045; add a meaningful alt
attribute (e.g., alt="section divider" or a description appropriate for the
image) to the <img> element so the tag becomes <img ... alt="..."> to restore
accessibility and satisfy the linter.

@DavidGBrett DavidGBrett enabled auto-merge May 25, 2026 06:42
@DavidGBrett DavidGBrett merged commit ef7d89d into dev May 25, 2026
6 checks passed
@DavidGBrett DavidGBrett deleted the add-official-channels-section-to-readme branch May 25, 2026 06:51
@jjw24 jjw24 added the bug Something isn't working label May 28, 2026
@jjw24 jjw24 modified the milestones: 2.2.0, 2.1.3 Jun 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working Documentation Update required to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants