generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Description
Description
A new interactive Web UI (simili-web) has been integrated into the project, allowing users to analyze issues in real-time with a shadcn-inspired interface. The current documentation does not cover the setup, configuration, or feature set of this interface.
We need to update the README.md (or create a dedicated WEB_UI.md) to ensure users can successfully deploy and navigate the new interface.
Key Features to Document
The documentation should highlight the following capabilities of the Web interface:
- Issue Submission: How to use the web form (Title, Body, Org, Repo).
- Analysis Tools: * Similarity scoring for existing issues.
- Duplicate detection powered by LLM reasoning.
- Quality scores and automated improvement suggestions.
- Recommendations: Labeling and repository transfer suggestions.
Setup & Deployment Instructions
The documentation must include the single-binary deployment steps and environment variable requirements:
Environment Variables
| Variable | Description |
|---|---|
GEMINI_API_KEY |
API key for LLM reasoning and suggestions. |
QDRANT_URL |
Endpoint for the vector database. |
QDRANT_API_KEY |
Authentication for Qdrant. |
QDRANT_COLLECTION |
Specific collection name for issue vectors. |
Running the UI
export GEMINI_API_KEY=xxx
export QDRANT_URL=xxx
export QDRANT_API_KEY=xxx
export QDRANT_COLLECTION=xxx
./simili-webReactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels