update readme with Wren AI API#1604
Conversation
WalkthroughThe README documentation was updated to highlight new features related to the Wren AI API. The previous section about exporting and visualizing data was replaced with information about embedding AI-powered SQL and chart generation directly into user applications via the Wren AI API. The update also introduced a new subsection under the "Why Wren AI?" section, emphasizing the capability to build AI agents and applications using the API. Visual assets and links were updated to reflect these changes. Changes
Poem
Suggested labels
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:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README.md (1)
129-138: Improve accessibility and punctuation consistency
The API documentation image at line 134 lacks analtattribute, which is flagged by markdownlint (MD045). Additionally, the link text on line 137 should end with a period for consistency.Proposed diff:
- <img src="./misc/API_doc.png" style="max-width: 700px"/> + <img alt="Screenshot of Wren AI API documentation" src="./misc/API_doc.png" style="max-width: 700px"/> - Check out the [full API documentation here](https://wrenai.readme.io/reference/welcome) + Check out the [full API documentation here](https://wrenai.readme.io/reference/welcome).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
134-134: Images should have alternate text (alt text)
null(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
misc/API_doc.pngis excluded by!**/*.png
📒 Files selected for processing (1)
README.md(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
134-134: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (go)
🔇 Additional comments (1)
README.md (1)
155-158: New "4. Embedded AI with Wren AI API" section is clear
The added subsection succinctly highlights building custom AI agents with the Wren AI API. No issues found.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
34-34: Add Oxford comma in feature list
To improve readability and maintain consistency with the Oxford comma style used elsewhere, please add a comma before "and embedded AI."- > Open-source GenBI AI Agent that empowers data-driven teams to chat with their data to generate Text-to-SQL, charts, spreadsheets, reports, BI and embedded AI. + > Open-source GenBI AI Agent that empowers data-driven teams to chat with their data to generate Text-to-SQL, charts, spreadsheets, reports, BI, and embedded AI.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
134-134: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Analyze (javascript-typescript)
- GitHub Check: Analyze (go)
🔇 Additional comments (2)
README.md (2)
129-133: Review new "Embedded AI-Powered SQL and Charts" section
The new heading and descriptive blockquote (lines 129–133) clearly outline the API-powered SQL and chart capabilities. Please ensure that numbering (“7.”) aligns with the feature list above. Otherwise, the content is spot-on.
155-158: Approve "Embedded AI with Wren AI API" under Why Wren AI?
The added subsection (lines 155–158) integrates smoothly with the “Why Wren AI?” section, succinctly highlighting how developers can leverage the API for GenBI agents. Formatting and tone match the existing points.
|
|
||
| <p align="center"> | ||
| <img src="./misc/wren-excel.png" style="max-width: 700px"/> | ||
| <img src="./misc/API_doc.png" style="max-width: 700px"/> |
There was a problem hiding this comment.
Add alt text to API documentation image
The <img> tag at line 134 is missing an alt attribute, which impacts accessibility. Please include a concise, descriptive alt text.
- <img src="./misc/API_doc.png" style="max-width: 700px"/>
+ <img src="./misc/API_doc.png" alt="Screenshot of Wren AI API documentation" style="max-width: 700px"/>📝 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.
| <img src="./misc/API_doc.png" style="max-width: 700px"/> | |
| <img src="./misc/API_doc.png" alt="Screenshot of Wren AI API documentation" style="max-width: 700px"/> |
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
134-134: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
2 participants
Summary by CodeRabbit