Combot v2.0 refactor #1
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
A major refactor of Combot’s documentation to match v2.0’s updated architecture, setup, and usage.
- Streamlines README to a concise installation and usage guide
- Updates prerequisites, environment configuration, and quick-start steps
- Adds file structure, commands list, and support section
Comments suppressed due to low confidence (2)
README.md:1
- Consider restoring a top-level project title using
# Combotand moving the descriptive text to a separate paragraph; this improves hierarchy and scannability.
## **Combot is a Discord bot designed for fighting game communities that imports combo data from YouTube playlists...**
README.md:66
- [nitpick] The file structure comments are misaligned (mixed indentation and spacing); aligning comment columns improves readability.
├── config.py # Configuration management
| DISCORD_BOT_TOKEN=your_bot_token_here | ||
| YOUTUBE_API_KEY=your_youtube_api_key_here | ||
| DISCORD_OWNER_IDS=your_discord_user_id_here | ||
| DISCORD_OWNER_IDS=your_discord_user_id |
There was a problem hiding this comment.
Clarify that DISCORD_OWNER_IDS can accept multiple comma-separated IDs for multi-owner setups, matching the environment variable name’s plural form.
| /update category:Midscreen playlist_or_url:https://youtube.com/playlist?list=YOUR_PLAYLIST_ID starter:5A | ||
| ``` | ||
| **Discord Bot Token:** | ||
| 1. Go to https://discord.com/developers/applications |
There was a problem hiding this comment.
[nitpick] The numbered steps under “Discord Bot Token” aren’t in a code block; consider wrapping them in a fenced code block to improve readability and distinguish commands/URLs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Combot v2.0 - Major Refactor Release
Overview
Complete rewrite of Combot architecture addressing code quality, maintainability, and reliability issues from v1.0.
Major Changes
Architecture & Code Quality
Bug Fixes
Performance Improvements
Security & Validation
User Experience
Developer Experience
Technical Improvements
Data Management
YouTube Integration
Discord UI
Breaking Changes
Migration Notes
Compatibility
Known Issues
This release represents a complete rewrite focusing on production stability, maintainability, and developer experience. All major issues from v1.0 have been resolved.