docs: add Telegram notifications documentation (issue #35) #40

agentson · 2026-02-04T23:48:27+09:00

agentson commented

2026-02-04 23:48:27 +09:00

Summary

Add comprehensive documentation for the Telegram notifications feature that was implemented in issues #31-34.

Changes

CLAUDE.md

Add Telegram Notifications section in Quick Start area
Quick setup guide (4 steps)
List of notification types with emojis
Fail-safe behavior explanation
Link to detailed documentation
Update project structure (notifications/ directory, 273 tests)

README.md (Korean)

Add 텔레그램 알림 section
Korean quick setup guide
Notification types in Korean
Fail-safe behavior in Korean
Update project structure diagram
Update core modules table

docs/architecture.md

Add Notifications component section (new #4)
Explain TelegramClient architecture and features
Add notification step to data flow diagram
Add Telegram env variables to Configuration section
Add Telegram API error handling documentation
Guarantee that notifications never interrupt trading

Documentation Coverage

✅ Quick setup instructions (bot creation, chat ID retrieval, env config)
✅ All notification types documented (6 types)
✅ Error handling and graceful degradation explained
✅ Link to detailed guide: src/notifications/README.md
✅ Both English (CLAUDE.md) and Korean (README.md) versions
✅ Architecture integration explained

Preview

Telegram Notification Types:

🟢 Trade execution (BUY/SELL with confidence)
🚨 Circuit breaker trips (critical alert)
⚠️ Fat-finger protection (order rejection)
ℹ️ Market open/close events
📝 System startup/shutdown status

Key Feature: Notifications are fail-safe — API errors or missing credentials never crash the trading system.

Closes #35

🤖 Generated with Claude Code

## Summary Add comprehensive documentation for the Telegram notifications feature that was implemented in issues #31-34. ## Changes ### CLAUDE.md - Add **Telegram Notifications** section in Quick Start area - Quick setup guide (4 steps) - List of notification types with emojis - Fail-safe behavior explanation - Link to detailed documentation - Update project structure (notifications/ directory, 273 tests) ### README.md (Korean) - Add **텔레그램 알림** section - Korean quick setup guide - Notification types in Korean - Fail-safe behavior in Korean - Update project structure diagram - Update core modules table ### docs/architecture.md - Add **Notifications** component section (new #4) - Explain TelegramClient architecture and features - Add notification step to data flow diagram - Add Telegram env variables to Configuration section - Add Telegram API error handling documentation - Guarantee that notifications never interrupt trading ## Documentation Coverage ✅ Quick setup instructions (bot creation, chat ID retrieval, env config) ✅ All notification types documented (6 types) ✅ Error handling and graceful degradation explained ✅ Link to detailed guide: [src/notifications/README.md](../src/notifications/README.md) ✅ Both English (CLAUDE.md) and Korean (README.md) versions ✅ Architecture integration explained ## Preview **Telegram Notification Types:** - 🟢 Trade execution (BUY/SELL with confidence) - 🚨 Circuit breaker trips (critical alert) - ⚠️ Fat-finger protection (order rejection) - ℹ️ Market open/close events - 📝 System startup/shutdown status **Key Feature**: Notifications are **fail-safe** — API errors or missing credentials never crash the trading system. ## Related Issues Closes #35 --- 🤖 Generated with [Claude Code](https://claude.com/claude-code)

agentson added 1 commit 2026-02-04 23:48:27 +09:00

docs: add Telegram notifications documentation (issue #35 )

CI / test (pull_request) Has been cancelled

Details

881bbb4240

Update project documentation to include Telegram notification feature
that was added in issues #31-34.

Changes:
- CLAUDE.md: Add Telegram quick setup section with examples
- README.md (Korean): Add 텔레그램 알림 section with setup guide
- docs/architecture.md: Add Notifications component documentation
  - New section explaining TelegramClient architecture
  - Add notification step to data flow diagram
  - Add Telegram config to environment variables
  - Document error handling for notification failures

Documentation covers:
- Quick setup instructions (bot creation, chat ID, env config)
- Notification types (trades, circuit breaker, fat-finger, etc.)
- Fail-safe behavior (notifications never crash trading)
- Links to detailed guide in src/notifications/README.md

Project structure updated to reflect notifications/ directory and
updated test count (273 tests).

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

jihoson merged commit 4b2bb25d03 into main

2026-02-04 23:49:46 +09:00

jihoson referenced this issue from a commit

2026-02-04 23:49:46 +09:00

Merge pull request 'docs: add Telegram notifications documentation (issue #35)' (#40) from feature/issue-35-telegram-docs into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jihoson/The-Ouroboros#40