Skip to content

Add cloud platform related guidance in readme - #27

Merged
hsballoon merged 4 commits into
AI45Lab:v2from
hsballoon:dbReadme
Jul 30, 2026
Merged

Add cloud platform related guidance in readme#27
hsballoon merged 4 commits into
AI45Lab:v2from
hsballoon:dbReadme

Conversation

@hsballoon

@hsballoon hsballoon commented Jul 29, 2026

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Documentation
    • Added a new “Optional: S3 + LanceDB Storage” section to both English and Chinese READMEs.
    • Included step-by-step setup for cloud-backed trajectory/environment persistence, including cloud requirements, local environment variables, and enabling cloud storage via startup flags.
    • Clarified how production vs test select corresponding data tables, and expanded the linked reference to cover querying and data retrieval.

@coderabbitai

coderabbitai Bot commented Jul 29, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f750b815-e0d9-482d-9366-72e31126b071

📥 Commits

Reviewing files that changed from the base of the PR and between 23ba5a4 and 5271b01.

📒 Files selected for processing (2)
  • README.md
  • README_CN.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • README_CN.md
  • README.md

📝 Walkthrough

Walkthrough

Adds bilingual README instructions for optional S3-backed LanceDB storage, including cloud dependencies, environment configuration, environment loading, gateway startup with production or test profiles, and data querying guidance.

Changes

Cloud storage documentation

Layer / File(s) Summary
Document cloud storage setup
README.md, README_CN.md
Adds English and Chinese instructions for cloud dependencies, .env SDK and S3 settings, environment loading, cloud storage selection, production/test profiles, and querying or retrieving data.

Estimated code review effort: 1 (Trivial) | ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title matches the README-only change and clearly summarizes the added cloud platform guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

209-217: 🔒 Security & Privacy | 🔵 Trivial | ⚡ Quick win

Scope HTTP S3 access to test/local usage. Both examples unconditionally set WT_SDK_S3_ALLOW_HTTP=true, including production guidance. Verify the SDK semantics and keep this disabled or omitted for production profiles.

  • README.md#L209-L217: split production and test examples so production does not enable HTTP.
  • README_CN.md#L201-L209: apply the same security correction in the Chinese example.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 209 - 217, Update the environment-variable examples
in README.md (lines 209-217) and README_CN.md (lines 201-209) to separate
production and test/local guidance: omit or disable WT_SDK_S3_ALLOW_HTTP for
production profiles while retaining it only for test/local usage, consistent
with the SDK’s semantics.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Around line 209-217: Update the environment-variable examples in README.md
(lines 209-217) and README_CN.md (lines 201-209) to separate production and
test/local guidance: omit or disable WT_SDK_S3_ALLOW_HTTP for production
profiles while retaining it only for test/local usage, consistent with the SDK’s
semantics.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 89d96dc4-e66d-4c4d-9973-040230ea965b

📥 Commits

Reviewing files that changed from the base of the PR and between 49caf96 and 23ba5a4.

📒 Files selected for processing (2)
  • README.md
  • README_CN.md

@WangXuhongCN
WangXuhongCN self-requested a review July 29, 2026 11:24
Comment thread README.md
Comment thread README_CN.md Outdated

@WangXuhongCN WangXuhongCN left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM with tiny changes

@coderabbitai coderabbitai Bot mentioned this pull request Jul 30, 2026
@hsballoon
hsballoon merged commit 108fdc2 into AI45Lab:v2 Jul 30, 2026
1 check was pending
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.

2 participants