Skip to content

Update README with full usage instructions#186

Open
user1303836 wants to merge 1 commit intomainfrom
docs/readme-usage-instructions
Open

Update README with full usage instructions#186
user1303836 wants to merge 1 commit intomainfrom
docs/readme-usage-instructions

Conversation

@user1303836
Copy link
Owner

Summary

  • Add semantic search documentation: /search command, parameters, examples, configuration settings (VOYAGE_API_KEY, SEARCH_EMBEDDING_MODEL, SEARCH_SIMILARITY_THRESHOLD, SEARCH_MAX_RESULTS)
  • Add missing commands: /source info, /github toggle
  • Add rate limit notes for /summarize and /search
  • Update project structure with search files (services/search.py, discord/cogs/search.py)
  • Expand "How It Works" section with embedding step
  • Add Voyage AI and GitHub token to Requirements and Setup sections
  • Remove stale test count reference

Test plan

  • Verify all documented commands match actual cog implementations
  • Verify all config variables match config.py Settings class
  • Verify project structure matches actual file tree

Add semantic search documentation (command, parameters, examples,
configuration settings), missing commands (/source info, /github toggle),
rate limit notes, updated project structure with search files, and
expanded How It Works section with embedding step.
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant