Update README.md#1665
Conversation
make readme much simpler
WalkthroughThe README.md file was reorganized and condensed for clarity and brevity. Sections were reordered, with detailed feature explanations and images removed or merged. The features list was streamlined, and architecture details were minimized. No code or exported entities were changed; all updates are limited to documentation. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure ✨ Finishing Touches🧪 Generate Unit Tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
make it simpler
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (5)
README.md (5)
60-60: Consider shortening this header for readability. It’s informative but quite long. For example:-### 4. Embedded AI-Powered SQL and Charts with the Wren AI API +### 4. Embedded AI-Powered SQL & Charts API
88-88: Capitalize subsection for consistency. Change to title case to match other headings:-### Ask any questions +### Ask Any Questions
93-93: Refactor call-to-action for clarity. Consider using a bullet list instead of inline text:-👉 Try with your data on [Wren AI Cloud](...) or [Install in your local environment](...) +**Try with your data:** +- Use [Wren AI Cloud](...) +- Or [Install locally](...)
95-95: Add emoji for section consistency. Other major sections include emojis. For example:-## Supported LLM Models +## 🤖 Supported LLM Models
97-108: Optional: Improve list readability. Consider grouping models into categories or presenting them in columns/tables to reduce vertical length.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
91-91: Bare URL used
null
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Analyze (go)
🔇 Additional comments (4)
README.md (4)
46-46: Approve updated Features section header. The addition of the 🤖 emoji aligns with your existing use of emojis in other major sections (e.g., 🎯 Our Vision & Mission, 🤔 Why Wren AI?).
56-56: Approve Semantic Layer subsection. The numbered header remains consistent and clear.
82-82: Approve call-to-action section header. The 🕶 emoji adds personality and is consistent with your style.
84-84: Approve GenBI demo subsection title. The heading is clear and matches the section’s focus.
| - ***[Wren UI](https://github.com/Canner/WrenAI/tree/main/wren-ui):*** An intuitive user interface for asking questions, defining data relationships, and integrating data sources. | ||
|
|
||
| - ***[Wren AI Service](https://github.com/Canner/WrenAI/tree/main/wren-ai-service):*** Processes queries using a vector database for context retrieval, guiding LLMs to produce precise SQL outputs. | ||
| https://github.com/user-attachments/assets/f9c1cb34-5a95-4580-8890-ec9644da4160 |
There was a problem hiding this comment.
Eliminate bare URL (MD034). Replace the raw link with descriptive anchor text. For example:
-[https://github.com/user-attachments/assets/f9c1cb34-5a95-4580-8890-ec9644da4160]
+[Ask a question demo](https://github.com/user-attachments/assets/f9c1cb34-5a95-4580-8890-ec9644da4160)Committable suggestion skipped: line range outside the PR's diff.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
91-91: Bare URL used
null
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In README.md at line 91, replace the bare URL with descriptive anchor text by
embedding the URL within markdown link syntax. Use meaningful text that
describes the link destination instead of showing the raw URL.
| ### GenBI (Generative Business Intelligence) | ||
|
|
||
| ## 🤖 Wren AI Text-to-SQL Agentic Architecture | ||
| [Watch GenBI Demo](https://github.com/user-attachments/assets/90ad1d35-bb1e-490b-9676-b29863ff090b) |
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Verify demo link validity. GitHub attachment URLs can change—please confirm it returns HTTP 200 and points to the intended media asset:
🏁 Script executed:
#!/bin/bash
curl -s -o /dev/null -w "%{http_code}\n" https://github.com/user-attachments/assets/90ad1d35-bb1e-490b-9676-b29863ff090bLength of output: 126
Ensure README demo link returns HTTP 200
The current attachment URL responds with HTTP 302 (redirect) rather than directly serving the media asset. Please update the link to point at the raw file and confirm it returns 200:
– File: README.md
– Line: 86
– Current snippet:
[Watch GenBI Demo](https://github.com/user-attachments/assets/90ad1d35-bb1e-490b-9676-b29863ff090b)– Action:
• Replace with the raw asset URL (for example, add ?raw=true or use the raw.githubusercontent.com path)
• Verify with:
shell curl -sL -o /dev/null -w "%{http_code}\n" <updated-URL>
and ensure it returns 200.
🤖 Prompt for AI Agents
In README.md at line 86, the demo link currently points to a GitHub attachment
URL that returns HTTP 302 instead of directly serving the media asset. Update
the link to use the raw file URL by either appending '?raw=true' to the existing
URL or replacing it with the corresponding raw.githubusercontent.com path. After
updating, verify the link returns HTTP 200 by running a curl command with the
updated URL.
| > [!CAUTION] | ||
| > The performance of Wren AI depends significantly on the capabilities of the LLM you choose. We strongly recommend using the most powerful model available for optimal results. Using less capable models may lead to reduced performance, slower response times, or inaccurate outputs. | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Use GitHub-compatible caution styling. The [!CAUTION] admonition isn’t supported in standard README.md. Replace with a warning emoji and bold label:
-> [!CAUTION]
-> The performance of Wren AI depends significantly...
+> ⚠️ **Caution:** The performance of Wren AI depends significantly...📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > [!CAUTION] | |
| > The performance of Wren AI depends significantly on the capabilities of the LLM you choose. We strongly recommend using the most powerful model available for optimal results. Using less capable models may lead to reduced performance, slower response times, or inaccurate outputs. | |
| > ⚠️ **Caution:** The performance of Wren AI depends significantly on the capabilities of the LLM you choose. We strongly recommend using the most powerful model available for optimal results. Using less capable models may lead to reduced performance, slower response times, or inaccurate outputs. |
🤖 Prompt for AI Agents
In README.md around lines 111 to 113, replace the unsupported `[!CAUTION]`
admonition with a GitHub-compatible format by using a warning emoji followed by
a bold "Caution:" label. This ensures the caution message is clearly visible and
properly rendered on GitHub without relying on unsupported syntax.
1 participant
make readme much simpler
Summary by CodeRabbit