Fix README typo#220
Conversation
WalkthroughREADME.md updated to add OS-specific guidance in Quick Start Step-1, replace tarball filenames with versioned Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Comment |
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
11-11: Fix small typos and grammar for polish.Applying these quick edits will align with the PR’s goal.
-... MongoDB API compability. +... MongoDB API compatibility.-👉 **Use Cases**: web applications, ducument store, ... +👉 **Use Cases**: web applications, document store, ...-All released package can be found at [download] page. +All released packages can be found on the [download] page.-After uncompress the package, you should see three directories: +After you uncompress the package, you should see three directories:-**Step-6**, open another terminal and run mongo client. +**Step-6**, open another terminal and run the Mongo shell client.-**Step-4**, start a S3 emulator, takes `minio` as an exmaple. +**Step-4**, start an S3 emulator (using MinIO as an example).-By default, `minio` listens on `http://127.0.0.1:9000`, whose default credentials is `minioadmin:minioadmin`,. +By default, MinIO listens on http://127.0.0.1:9000. The default credentials are `minioadmin:minioadmin`.-... EloqDoc-RocksDB and EloqDocRocksDBCloud from scratch. +... EloqDoc-RocksDB and EloqDoc-RocksDBCloud from scratch.Also applies to: 19-19, 68-68, 76-76, 100-104, 145-145, 155-156, 193-194
🧹 Nitpick comments (3)
README.md (3)
73-74: Use gzip flag and quote paths for portability.On some systems tar needs
-zto handle.tar.gz. Also quote$HOMEpaths.-mkdir $HOME/eloqdoc-rocksdb && tar -xf eloqdoc-0.2.6-ubuntu22-amd64.tar.gz -C $HOME/eloqdoc-rocksdb +mkdir -p "$HOME/eloqdoc-rocksdb" && tar -xzf eloqdoc-0.2.6-ubuntu22-amd64.tar.gz -C "$HOME/eloqdoc-rocksdb"-mkdir $HOME/eloqdoc-rocksdbcloud && tar -xf eloqdoc-0.2.6-ubuntu22-amd64.tar.gz -C $HOME/eloqdoc-rocksdbcloud +mkdir -p "$HOME/eloqdoc-rocksdbcloud" && tar -xzf eloqdoc-0.2.6-ubuntu22-amd64.tar.gz -C "$HOME/eloqdoc-rocksdbcloud"Also applies to: 129-130
65-66: Optional: parameterize version to reduce churn.Consider documenting with a version variable to ease future updates.
export ELOQDOC_VERSION=0.2.6 wget -c "https://download.eloqdata.com/eloqdoc/eloqdss_rocksdb/eloqdoc-${ELOQDOC_VERSION}-ubuntu22-amd64.tar.gz"And similarly for RocksDBCloud.
Also applies to: 121-122
62-66: Clarify supported OS/architectures or add a package matrixDownload links are valid (HTTP 200). To avoid confusion for non-Ubuntu users, explicitly state the supported OS/arch (e.g. Ubuntu 22.04 x86_64) or include a table listing all available packages (Ubuntu 22, Ubuntu 24, macOS arm64, etc.) with their respective links.
Applies also to the Rocks S3 section (lines 118–122).
2 participants
Summary by CodeRabbit