Skip to content

Update README.md#1168

Merged
douenergy merged 1 commit intomainfrom
chilijung-patch-1
Apr 26, 2025
Merged

Update README.md#1168
douenergy merged 1 commit intomainfrom
chilijung-patch-1

Conversation

@chilijung
Copy link
Copy Markdown
Member

@chilijung chilijung commented Apr 26, 2025

  • Supported Data Sources with links

Summary by CodeRabbit

  • Documentation
    • Added a "Supported Data Sources" section to the README, listing and linking all data sources compatible with Wren Engine.

- Supported Data Sources with links
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 26, 2025

Walkthrough

A new section titled "Supported Data Sources" has been added to the README.md file. This section appears directly after the Wren Engine overview image and provides a list of supported data sources, each with a link to its respective API documentation tag. No other changes or modifications to code or structure were made.

Changes

File(s) Change Summary
README.md Added a "Supported Data Sources" section listing and linking supported data sources after overview image.

Possibly related PRs

  • add overview image #1154: Introduced the overview image in the README, which is the reference point for the placement of the new "Supported Data Sources" section.

Suggested labels

documentation

Suggested reviewers

  • goldmedal
  • douenergy

Poem

A hop and a skip, a README anew,
With sources galore for all to review!
From S3 to Snowflake, the list is now clear,
Linked for explorers who venture near.
🐇✨
Hopping through docs, making things bright,
Every data source now in plain sight!


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 26, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
README.md (2)

31-31: Enhance context with an introductory sentence
Right after the ## 🔌 Supported Data Sources heading, consider adding a brief description—such as “Wren Engine currently supports connecting to the following data sources:”—to give readers immediate context before they scan the list.


32-42: Optional: Sort or group the data sources
The list isn’t strictly alphabetical—consider ordering entries alphabetically or grouping by category (e.g., cloud warehouses, relational databases, file stores) to help users locate their connector more quickly.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f3be4b and e503835.

📒 Files selected for processing (1)
  • README.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: ci
  • GitHub Check: Analyze (java-kotlin)
🔇 Additional comments (1)
README.md (1)

32-42:

Details

✅ Verification successful

Verify documentation link health
Broken or outdated anchors can confuse users. Please run the following script to ensure each URL in this block returns HTTP 200:


🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

urls=(
  "https://docs.getwren.ai/oss/wren_engine_api#tag/BigQueryConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/GcsFileConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/LocalFileConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/MSSqlConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/MinioFileConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/MySqlConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/OracleConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/PostgresConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/S3FileConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/SnowflakeConnectionInfo"
  "https://docs.getwren.ai/oss/wren_engine_api#tag/TrinoConnectionInfo"
)

for url in "${urls[@]}"; do
  status=$(curl -s -o /dev/null -w "%{http_code}" "$url")
  if [[ "$status" -ne 200 ]]; then
    echo "⚠️ $url returned HTTP $status"
  fi
done

Length of output: 2701


Documentation link health verified
All listed URLs in README.md returned HTTP 200—no broken or outdated anchors detected.

@douenergy
Copy link
Copy Markdown
Contributor

Thansk @chilijung

@douenergy douenergy merged commit af39ab2 into main Apr 26, 2025
7 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants