-
Notifications
You must be signed in to change notification settings - Fork 15
[Good First Issue]: Add missing command documentation #27
Copy link
Copy link
Open
Labels
Priority: MediumNormal priority. Should be addressed in due time.Normal priority. Should be addressed in due time.Status: OpenIssue is open and ready for work.Issue is open and ready for work.documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
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
/commandsor 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Priority: MediumNormal priority. Should be addressed in due time.Normal priority. Should be addressed in due time.Status: OpenIssue is open and ready for work.Issue is open and ready for work.documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers