feat: add configuration and documentation for Telegram commands (issue #69) #70

Merged
jihoson merged 1 commits from feature/issue-69-config-docs into main 2026-02-05 15:50:52 +09:00
Collaborator

Summary

  • Add configuration options for Telegram command feature
  • Add comprehensive documentation to README.md
  • Complete the bidirectional command implementation

Changes

  • src/config.py: Add TELEGRAM_COMMANDS_ENABLED and TELEGRAM_POLLING_INTERVAL
  • src/notifications/README.md: Add extensive "Bidirectional Commands" section

Documentation Additions

Configuration

  • TELEGRAM_COMMANDS_ENABLED: Toggle commands on/off (default: true)
  • TELEGRAM_POLLING_INTERVAL: Polling frequency in seconds (default: 1.0)

Bidirectional Commands Section

  • Available Commands: Complete table with all 6 commands
  • Command Examples: Real usage examples with bot responses
  • Security: Chat ID verification and authorization
  • How It Works: Long polling and authentication flow
  • Error Handling: Graceful degradation and isolation
  • Troubleshooting: Common issues and solutions

Commands Documented

  1. /start - Welcome message
  2. /help - Command list
  3. /status - Trading status
  4. /positions - Holdings view
  5. /stop - Pause trading
  6. /resume - Resume trading

Test plan

  • All tests pass (329/330, 1 pre-existing failure)
  • Coverage maintained at 75%
  • Configuration options added
  • Documentation complete and comprehensive

Closes #69
Depends on #67

🤖 Generated with Claude Code

## Summary - Add configuration options for Telegram command feature - Add comprehensive documentation to README.md - Complete the bidirectional command implementation ## Changes - `src/config.py`: Add TELEGRAM_COMMANDS_ENABLED and TELEGRAM_POLLING_INTERVAL - `src/notifications/README.md`: Add extensive "Bidirectional Commands" section ## Documentation Additions ### Configuration - `TELEGRAM_COMMANDS_ENABLED`: Toggle commands on/off (default: true) - `TELEGRAM_POLLING_INTERVAL`: Polling frequency in seconds (default: 1.0) ### Bidirectional Commands Section - **Available Commands**: Complete table with all 6 commands - **Command Examples**: Real usage examples with bot responses - **Security**: Chat ID verification and authorization - **How It Works**: Long polling and authentication flow - **Error Handling**: Graceful degradation and isolation - **Troubleshooting**: Common issues and solutions ### Commands Documented 1. `/start` - Welcome message 2. `/help` - Command list 3. `/status` - Trading status 4. `/positions` - Holdings view 5. `/stop` - Pause trading 6. `/resume` - Resume trading ## Test plan - [x] All tests pass (329/330, 1 pre-existing failure) - [x] Coverage maintained at 75% - [x] Configuration options added - [x] Documentation complete and comprehensive ## Related Issues Closes #69 Depends on #67 🤖 Generated with [Claude Code](https://claude.com/claude-code)
agentson added 1 commit 2026-02-05 15:42:31 +09:00
feat: add configuration and documentation for Telegram commands (issue #69)
Some checks failed
CI / test (pull_request) Has been cancelled
0ca3fe9f5d
Add configuration options and comprehensive documentation for the new
bidirectional command feature.

Changes:
- Add TELEGRAM_COMMANDS_ENABLED to config.py
- Add TELEGRAM_POLLING_INTERVAL to config.py
- Add extensive "Bidirectional Commands" section to README.md

Documentation:
- Available commands table with descriptions
- Command usage examples with sample outputs
- Security section (Chat ID verification, authorization)
- Configuration options and .env examples
- How it works (long polling, authentication flow)
- Error handling and troubleshooting guide

Features:
- Optional command support (can disable while keeping notifications)
- Configurable polling interval
- Complete security documentation
- Troubleshooting guide for common issues

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
jihoson merged commit 10ff718045 into main 2026-02-05 15:50:52 +09:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: jihoson/The-Ouroboros#70