docs: Add Slack community invite badge to home page README. #1418

AVMatthews · 2025-10-14T18:04:42Z

Description

Added button at top of README.md for our slack invite link. Same as on the main YScope webpage.

Checklist

The PR satisfies the contribution guidelines.
This is a breaking change and that has been indicated in the PR title, OR this isn't a
breaking change.
Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Checked that the button works and renders correctly in GitHub.

Summary by CodeRabbit

Documentation
- Added a Slack community badge and included Slack links in the Community and Next Steps sections to improve discoverability.
- Updated Discord badge color for visual consistency.
- Reordered some community entries so Slack appears alongside existing links.
- Content-only changes; no functional or behavioral changes.

coderabbitai · 2025-10-14T18:05:11Z

Walkthrough

Added Slack integration references and updated badge metadata in README.md: inserted a Slack badge, declared Slack community link identifiers, updated the Discord badge color (labelColor), and made minor content reordering; documentation-only change, no code or API modifications.

Changes

Cohort / File(s)	Summary of Changes
Documentation (README) `README.md`	Added Slack badge to badges section; added Slack community link identifiers and Slack links in Community and Next Steps; updated Discord badge `labelColor`; minor content reordering and link list updates.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "docs: Add Slack community invite badge to home page README" directly corresponds to the main objective and changes in this pull request. According to the raw summary and PR objectives, the primary change is introducing a Slack community invite badge to the README.md file, which is precisely what the title conveys. The title uses the conventional commit format with a "docs:" prefix, is concise and specific, and clearly indicates both what was added (Slack community invite badge) and where it was added (home page README). There is no vagueness, misleading information, or unnecessary noise in the title.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ 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: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aef86bd and bb51481.

📒 Files selected for processing (1)

README.md (3 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2024-10-24T14:25:17.978Z

Learnt from: haiqi96
PR: y-scope/clp#523
File: components/core/src/clp/clp/FileCompressor.hpp:58-78
Timestamp: 2024-10-24T14:25:17.978Z
Learning: When reviewing legacy code refactors, avoid suggesting changes that would extend the scope of the PR.

Applied to files:

README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

GitHub Check: package-image
GitHub Check: rust-checks (ubuntu-24.04)
GitHub Check: lint-check (ubuntu-24.04)
GitHub Check: rust-checks (ubuntu-22.04)

🔇 Additional comments (3)

README.md (3)

6-6: Slack badge integrations look good. ✓

Both the top-level badges section (line 6) and the Community section (line 93) are properly updated with consistent Slack badge references, mirroring the Discord and Zulip pattern.

Also applies to: 93-93

101-102: Encoding and styling consistency achieved.

Both Discord (line 101) and Slack (line 102) badges now use consistent parameter styles (style=flat) and bare hex values for colours (no %23 encoding), aligning with the official shields.io documentation style as discussed in previous reviews.

The green colour (1e724f) matches the consensus selection from earlier discussions.

124-124: Verify the Slack invite link remains active.

The community inviter URL pattern appears valid, though please confirm the Slack workspace invite link (https://communityinviter.com/apps/yscopecommunity/yscope-community) is still actively managed and accessible before merging.

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

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)
88-94: Add Slack to the Community list for discoverability.

Top badges show Slack, but the Community bullets omit it. Suggest adding a Slack entry alongside Discord and Zulip.
 Need help? Join us on one of our community servers:

-* [![Discord][badge-discord]][yscope-community-discord]
+* [![Discord][badge-discord]][yscope-community-discord]
+* [![Slack][badge-slack]][yscope-community-slack]
 * [![CLP on Zulip][badge-zulip]][yscope-community-zulip]

📜 Review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6623829 and 7d63747.

📒 Files selected for processing (1)

README.md (3 hunks)

🔇 Additional comments (2)

README.md (2)

6-6: LGTM: Slack badge added correctly.

Reference and link resolve; placement matches other badges.

123-123: Confirm invite link stability and policy.

Is the CommunityInviter URL non-expiring and intended for public sharing? If tokens rotate, consider a vanity redirect (e.g., https://yscope.com/slack) to avoid future README edits.

README.md

quinntaylormitchell

Looks good fundamentally; only one comment on the code and another one here:

I couldn't add this to the code as it's out of the diff range, but the new Slack badge should also be added to the "Community" section (in between the Discord and Zulip links)

README.md

quinntaylormitchell · 2025-10-14T19:05:16Z

Also, for the PR title, how about

docs: Add Slack community invite badge to home page README.

README.md

junhaoliao

the PR title lgtm

quinntaylormitchell

lgtm!

Requested changes have been addressed.

* feat(webui): Add drawer to display guided query and errors. (y-scope#1421) * docs: Add Slack community invite badge to home page README. (y-scope#1418) * refactor(clp-package): Simplify StrEnum and Path serialization via Annotated serializers. (y-scope#1417) Co-authored-by: Junhao Liao <junhao@junhao.ca> Co-authored-by: Junhao Liao <junhao.liao@yscope.com> * build(clp-package): Adopt uv + hatchling as the build and packaging backend for Python components (resolves y-scope#1396); Upgrade dependencies for Python components. (y-scope#1405) * chore(docker): Add `--link` flags to COPY/ADD operations for improved build performance (fixes y-scope#1408). (y-scope#1411) * fix(ci): Correctly update and restore cache of `lint:check-cpp-lint-static-full`'s generated files (fixes y-scope#1419): (y-scope#1430) - Save cache entries using unique key per entry. - Restore latest entries using key prefix. - Avoid using outputs from optionally-run `restore` task. * fix(clp-rust-utils): Use AWS SDK default configuration with latest behavior version for S3 client. (y-scope#1445) Co-authored-by: Junhao Liao <junhao.liao@yscope.com> * refactor(clp-package): Remove unused `python-dotenv` dependency and related imports (fixes y-scope#1443). (y-scope#1444) * fix(webui): Submit queries that failed ANTLR validation to Presto. (y-scope#1450) * feat(clp-s): Explicitly reject unstructured log inputs during compression. (y-scope#1434) * feat(webui): Show query speed in native search status. (y-scope#1429) * fix(job-orchestration): Make `tag_ids` a required `list[int]` for compatibility with Spider compressor. (y-scope#1453) * feat(clp-mcp-server): Add log viewer links to query results for displaying in LLM output. (y-scope#1454) Co-authored-by: Junhao Liao <junhao.liao@yscope.com> * feat(ci): Add tasks for checking and updating Rust lock file (`Cargo.lock`); Add check to GH workflow. (y-scope#1448) * feat(webui): Trigger submit action when pressing Enter on Monaco single line editor. (y-scope#1459) * Add filters. * Update cargo lock. --------- Co-authored-by: davemarco <83603688+davemarco@users.noreply.github.com> Co-authored-by: Abigail Matthews <abigail.v.matthews@gmail.com> Co-authored-by: sitaowang1998 <sitaowang1998@outlook.com> Co-authored-by: Junhao Liao <junhao@junhao.ca> Co-authored-by: Junhao Liao <junhao.liao@yscope.com> Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> Co-authored-by: Devin Gibson <gibber9809@users.noreply.github.com> Co-authored-by: hoophalab <200652805+hoophalab@users.noreply.github.com> Co-authored-by: Huangshi Tian <All-less@users.noreply.github.com>

* feat(webui): Add drawer to display guided query and errors. (y-scope#1421) * docs: Add Slack community invite badge to home page README. (y-scope#1418) * refactor(clp-package): Simplify StrEnum and Path serialization via Annotated serializers. (y-scope#1417) Co-authored-by: Junhao Liao <junhao@junhao.ca> Co-authored-by: Junhao Liao <junhao.liao@yscope.com> * build(clp-package): Adopt uv + hatchling as the build and packaging backend for Python components (resolves y-scope#1396); Upgrade dependencies for Python components. (y-scope#1405) * chore(docker): Add `--link` flags to COPY/ADD operations for improved build performance (fixes y-scope#1408). (y-scope#1411) * fix(ci): Correctly update and restore cache of `lint:check-cpp-lint-static-full`'s generated files (fixes y-scope#1419): (y-scope#1430) - Save cache entries using unique key per entry. - Restore latest entries using key prefix. - Avoid using outputs from optionally-run `restore` task. * fix(clp-rust-utils): Use AWS SDK default configuration with latest behavior version for S3 client. (y-scope#1445) Co-authored-by: Junhao Liao <junhao.liao@yscope.com> * refactor(clp-package): Remove unused `python-dotenv` dependency and related imports (fixes y-scope#1443). (y-scope#1444) * fix(webui): Submit queries that failed ANTLR validation to Presto. (y-scope#1450) * feat(clp-s): Explicitly reject unstructured log inputs during compression. (y-scope#1434) * feat(webui): Show query speed in native search status. (y-scope#1429) * fix(job-orchestration): Make `tag_ids` a required `list[int]` for compatibility with Spider compressor. (y-scope#1453) * feat(clp-mcp-server): Add log viewer links to query results for displaying in LLM output. (y-scope#1454) Co-authored-by: Junhao Liao <junhao.liao@yscope.com> * feat(ci): Add tasks for checking and updating Rust lock file (`Cargo.lock`); Add check to GH workflow. (y-scope#1448) * feat(webui): Trigger submit action when pressing Enter on Monaco single line editor. (y-scope#1459) * Add filters. * Update cargo lock. * Stupid fix --------- Co-authored-by: davemarco <83603688+davemarco@users.noreply.github.com> Co-authored-by: Abigail Matthews <abigail.v.matthews@gmail.com> Co-authored-by: sitaowang1998 <sitaowang1998@outlook.com> Co-authored-by: Junhao Liao <junhao@junhao.ca> Co-authored-by: Junhao Liao <junhao.liao@yscope.com> Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com> Co-authored-by: Devin Gibson <gibber9809@users.noreply.github.com> Co-authored-by: hoophalab <200652805+hoophalab@users.noreply.github.com> Co-authored-by: Huangshi Tian <All-less@users.noreply.github.com>

junhaoliao · 2025-10-29T04:49:45Z

README.md

 Need help? Join us on one of our community servers:

 * [![Discord][badge-discord]][yscope-community-discord]
+* [![Slack][badge-slack]][yscope-community-slack]


let's also add this to

clp/docs/src/index.md

Lines 100 to 105 in 56ebca1

## Community

Need help? Join us on one of our community servers:

* [![Discord][badge-discord]][yscope-community-discord]

* [![CLP on Zulip][badge-zulip]][yscope-community-zulip]

@coderabbitai create an issue

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash # First, let's check the current content of the docs/src/index.md file around lines 100-105 echo "=== Current content of docs/src/index.md around lines 100-105 ===" cat docs/src/index.md | sed -n '95,110p' | nl -v 95 echo "" echo "=== Creating GitHub issue ===" # Create the issue gh issue create \ --title "docs: Add Slack community invite badge to documentation site index" \ --body "## Description Add the Slack community invite badge to the documentation site's index page (\`docs/src/index.md\`) to match the badge added to the main README. ## Context The Slack badge was added to the main README.md in PR #1418. For consistency, it should also be added to the documentation site index at the community links section (around lines 100-105). ## Reference - File: \`docs/src/index.md\` - Location: https://github.com/y-scope/clp/blob/56ebca1ea4dcf4bd50a20a35197dd7b502f42f86/docs/src/index.md?plain=1#L100-L105 - Related PR: #1418 - Related comment: https://github.com/y-scope/clp/pull/1418#discussion_r2471728685 ## Badge Details Use the same badge configuration as in README.md: - Badge markdown: \`[![Slack][badge-slack]][yscope-community-slack]\` - Badge definition: \`[badge-slack]: https://img.shields.io/badge/Slack-yscope--community-1e724f?style=flat&logo=slack&logoColor=white&labelColor=4A154B\` - Link definition: \`[yscope-community-slack]: https://communityinviter.com/apps/yscopecommunity/yscope-community\` Requested by: @junhaoliao" \ --assignee junhaoliao

Length of output: 180

@junhaoliao, I've created issue #1520 to track adding the Slack community badge to docs/src/index.md. The issue includes:

Reference to the specific location in the documentation site index

Badge configuration details matching the ones used in README.md

Backlinks to this PR (docs: Add Slack community invite badge to home page README. #1418) and comment

Assignment to you

You can view the issue here: #1520

Add Slack invite button to README.md

7d63747

AVMatthews requested a review from a team as a code owner October 14, 2025 18:04

coderabbitai bot reviewed Oct 14, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

junhaoliao reviewed Oct 14, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

quinntaylormitchell requested changes Oct 14, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

AVMatthews changed the title ~~docs: Add Slack invite button to README.~~ docs: Add Slack community invite badge to home page README. Oct 15, 2025

Change colors of badge

aef86bd

junhaoliao previously requested changes Oct 16, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

junhaoliao reviewed Oct 16, 2025

View reviewed changes

AVMatthews added 2 commits October 16, 2025 19:29

Standardize badge label hex ccolors

bb51481

Merge branch 'main' into slackButton

cfeb04d

kirkrodrigues approved these changes Oct 17, 2025

View reviewed changes

Merge branch 'main' into slackButton

9b3732d

quinntaylormitchell approved these changes Oct 17, 2025

View reviewed changes

AVMatthews merged commit 0cc49ff into y-scope:main Oct 17, 2025
22 checks passed

junhaoliao reviewed Oct 29, 2025

View reviewed changes

coderabbitai bot mentioned this pull request Oct 29, 2025

docs: Add Slack community invite badge to documentation site index #1520

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

docs: Add Slack community invite badge to home page README. #1418

docs: Add Slack community invite badge to home page README. #1418

Uh oh!

AVMatthews commented Oct 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Oct 14, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

quinntaylormitchell left a comment

Uh oh!

Uh oh!

quinntaylormitchell commented Oct 14, 2025

Uh oh!

Uh oh!

junhaoliao left a comment

Uh oh!

quinntaylormitchell left a comment

Uh oh!

Uh oh!

junhaoliao Oct 29, 2025

Uh oh!

coderabbitai bot Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	## Community

	Need help? Join us on one of our community servers:

	* [![Discord][badge-discord]][yscope-community-discord]
	* [![CLP on Zulip][badge-zulip]][yscope-community-zulip]

Uh oh!

docs: Add Slack community invite badge to home page README. #1418

docs: Add Slack community invite badge to home page README. #1418

Uh oh!

Conversation

AVMatthews commented Oct 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Validation performed

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

quinntaylormitchell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

quinntaylormitchell commented Oct 14, 2025

Uh oh!

Uh oh!

junhaoliao left a comment

Choose a reason for hiding this comment

Uh oh!

quinntaylormitchell left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

junhaoliao Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

AVMatthews commented Oct 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 14, 2025 •

edited

Loading