Skip to content

docs: update README for Slack/Telegram adapters#18

Merged
Royal-lobster merged 3 commits intomainfrom
docs/update-readme-adapters
Apr 10, 2026
Merged

docs: update README for Slack/Telegram adapters#18
Royal-lobster merged 3 commits intomainfrom
docs/update-readme-adapters

Conversation

@Royal-lobster
Copy link
Copy Markdown
Member

Summary

  • Updates Quick Start to show all three adapters (Discord, Slack, Telegram) with adapter-owned routing
  • Rewrites Multi-Channel Routing section for the new per-adapter channels/tags/mentions pattern
  • Removes deprecated pings from per-environment config examples
  • Removes global routing from full configuration reference
  • Updates adapters table — Slack and Telegram are now built-in

Follows up on #16.

🤖 Generated with Claude Code

Royal-lobster and others added 3 commits April 10, 2026 21:59
Covers adapter-owned routing (Approach A), message formatting,
rate limits, breaking changes to RoutingConfig/FormattedAlert,
and migration path from global routing to per-adapter config.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…ting

- Quick Start shows all three adapters (Discord, Slack, Telegram)
- Multi-Channel Routing updated to adapter-owned config pattern
- Per-Environment Config removes deprecated pings field
- Full Configuration removes global routing section
- Adapters table marks Slack and Telegram as built-in

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@Royal-lobster Royal-lobster merged commit 0338783 into main Apr 10, 2026
3 checks passed
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation to reflect that Slack and Telegram adapters are now built-in. It also documents the transition from a global routing configuration to a per-adapter routing model, providing updated examples for Discord, Slack, and Telegram. A suggestion was made to clarify that the mentions property expects an array of strings for better alignment with the underlying type definitions.

Comment thread README.md
webhookUrl: '...',
channels: {}, // level → webhook URL
tags: {}, // tag → webhook URL
mentions: {}, // level → mention strings
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The comment level → mention strings is slightly ambiguous. Since the mentions property in DiscordAdapterOptions (and other adapters) is typed as Partial<Record<AlertLevel, string[]>>, it would be clearer to specify that it expects an array of strings, as shown in the examples above.

Suggested change
mentions: {}, // level → mention strings
mentions: {}, // level → string[] (mentions)
References
  1. The AlertLevel type for warnings is 'warning', which is distinct from the API method name .warn().

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