Skip to content

[Good First Issue]: Add missing command documentation #27

@youngcoder45

Description

@youngcoder45

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:

  1. Go through the command files in the bot (likely inside /commands or similar folder)
  2. List all available commands
  3. Compare with README or docs
  4. Identify missing or incomplete entries
  5. Add:
    • Command description
    • Usage syntax
    • Example usage
  6. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Priority: MediumNormal priority. Should be addressed in due time.Status: OpenIssue is open and ready for work.documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions