Skip to content

docs: add Discord community link to docs, README, and PyPI URLs#141

Merged
ZmeiGorynych merged 3 commits into
mainfrom
egor/add-discord-link
May 22, 2026
Merged

docs: add Discord community link to docs, README, and PyPI URLs#141
ZmeiGorynych merged 3 commits into
mainfrom
egor/add-discord-link

Conversation

@ZmeiGorynych
Copy link
Copy Markdown
Member

@ZmeiGorynych ZmeiGorynych commented May 22, 2026

What

Surface the community Discord invite (https://discord.gg/djtaFyXW) in the main public-facing entry points, which previously had no reference to it.

Changes

  • docs/index.md — append Discord to the GitHub | PyPI link row on the docs home page.
  • README.md — add a static Discord shields.io pill to the badge cluster under the hero image, plus a short "Questions, ideas, or feedback? Join our Discord" blurb under the star line.
  • pyproject.toml — add a Discord entry to [tool.poetry.urls] so it shows on the PyPI project sidebar alongside Repository and Documentation.

Notes

  • A static shields badge is used (Discord-join) rather than a dynamic member-count badge, because only the invite code is known — not the numeric server ID that img.shields.io/discord/<id> requires.
  • mkdocs.yml was intentionally skipped: the theme is readthedocs, which has no clean extra.social footer-icon slot.

Docs/config only — no production code changes, so no tests added.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Added a Discord community invite link to the project header and updated the feedback call-to-action to point to the Discord invite.
    • Added the Discord invite URL to the documentation index links.
  • Chores

    • Updated project metadata to include the Discord community invite link.

Review Change Stack

Surface the community Discord invite in the main public entry points:
- docs/index.md link row (GitHub | PyPI | Discord)
- README badge cluster (static shields pill) + a short community blurb
- pyproject.toml [tool.poetry.urls] (shows on the PyPI project sidebar)

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b7ed7ae2-c4ba-4fed-8652-f912f5d5f465

📥 Commits

Reviewing files that changed from the base of the PR and between e4ad7bd and 4c44f56.

📒 Files selected for processing (1)
  • README.md
✅ Files skipped from review due to trivial changes (1)
  • README.md

📝 Walkthrough

Walkthrough

Adds the project's Discord invite link in three places: a Discord badge and updated feedback CTA in README, the Discord URL in docs/index.md header links, and a Discord entry under [tool.poetry.urls] in pyproject.toml.

Changes

Discord Community Links

Layer / File(s) Summary
Add Discord links to documentation and project metadata
README.md, docs/index.md, pyproject.toml
Discord invite link is exposed in the README header badge and feedback prompt, in the documentation index link list, and in project metadata as a poetry URL entry.

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs:

  • MotleyAI/slayer#5: Also updates README badge/link area; overlaps in README top-section edits.

🐰 I found a cozy invite bright,
A badge that gleams with friendly light,
README, docs, and pyproject too,
Now whisper, "Join us—come on through!"
Hops and welcomes—see you in the night.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: adding Discord community links to documentation, README, and PyPI metadata.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch egor/add-discord-link

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

ZmeiGorynych and others added 2 commits May 22, 2026 17:07
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The README is the repo's own front page, so the link pointed back to itself.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@sonarqubecloud
Copy link
Copy Markdown

@ZmeiGorynych ZmeiGorynych merged commit e907e4e into main May 22, 2026
6 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request May 26, 2026
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant