Some bot commands are either missing from the documentation or lack proper usage examples. This issue focuses on improving documentation completeness and clarity.
Context:
Good documentation is essential for usability and onboarding new users. Currently, some commands are either undocumented or poorly explained, which makes it difficult for users and contributors to understand the bot’s capabilities.
Suggested approach:
- Go through the command files in the bot (likely inside
/commands or similar folder)
- List all available commands
- Compare with README or docs
- Identify missing or incomplete entries
- Add:
- Command description
- Usage syntax
- Example usage
- Ensure formatting is consistent
Acceptance criteria:
- All commands are documented
- Each command has a clear description and example
- Documentation is clean and readable
Files / areas to look at:
- README.md
- docs/ (if exists)
- commands/ or bot command handler files
Checklist:
- The scope is small enough for a first contribution.
- Acceptance criteria are clear and testable.
- Relevant pointers/links are included.
Some bot commands are either missing from the documentation or lack proper usage examples. This issue focuses on improving documentation completeness and clarity.
Context:
Good documentation is essential for usability and onboarding new users. Currently, some commands are either undocumented or poorly explained, which makes it difficult for users and contributors to understand the bot’s capabilities.
Suggested approach:
/commandsor similar folder)Acceptance criteria:
Files / areas to look at:
Checklist: