Update README

[zhangh43]

1. add architecture section
2. add benchmark section

Summary by CodeRabbit

• Documentation
  • Enhanced README with clearer architecture explanations covering storage management, caching, and durability
  • Added architectural diagrams and visual references
  • Expanded Quick Start section with additional setup examples and configuration options
  • Improved terminology and readability throughout

[coderabbitai]

Walkthrough

This pull request updates the README.md documentation to better communicate the project's MongoDB API compatibility, cloud-native architecture, and storage-centric design. The changes include architectural restructuring, expanded explanations of data management strategies, enhanced Quick Start instructions, and corrected typographic issues throughout.

Changes

Cohort / File(s)

Summary

Documentation overhaul README.md

Restructured architecture sections from "Distributed Architecture" to "Tiered Storage Architecture"; expanded descriptions of hot/cold data management, NVMe caching, cross-AZ durability, and decoupled components; updated scalability and data management explanations; enhanced Quick Start section with additional package examples (EloqDoc-RocksDB, EloqDoc-RocksDBCloud) and local setup instructions including MinIO configuration; added architecture visualization section; corrected terminology and improved formatting throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

This is a pure documentation update with no code logic changes. The review involves verifying content accuracy, terminology consistency, and formatting clarity rather than analyzing algorithmic or functional complexity.

Possibly related PRs

• eloqdata/eloqdoc#205: Modifies the README's Quick Start section and updates EloqDoc-RocksDBCloud extraction instructions, directly aligned with this PR's Quick Start enhancements.

Suggested reviewers

• lzxddz

Poem

🐰 Hops through the docs with pride so high,
MongoDB API beneath our sky,
Tiered storage shines, architecture clear,
Hot and cold data, far and near,
Quick Start blooms with examples new—
Words refined, the story's true! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The pull request title "Update README" is vague and generic, providing no meaningful information about the actual changes within the changeset. While the title is technically related to the work (the README is indeed being updated), it fails to convey what the main changes are. According to the PR objectives, the primary goals are to add an architecture section and a benchmark section, with substantial restructuring and expansion of content, yet the title gives no indication of these specifics. This is precisely the type of non-descriptive terminology that should be avoided in pull request titles.	Consider using a more descriptive title that highlights the primary changes, such as "Add architecture and benchmark sections to README" or "Restructure README with architecture and scalability details." This would give reviewers and future readers a clear understanding of what the changeset accomplishes without needing to examine the full diff.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

README.md (3)

49-85: Fix typos in Architecture section headings/text

Please tidy up a few wording slips here: change “Truely” → “Truly” in the section heading, and “This architecture enable” → “This architecture enables.” Keeps the doc polished.

Apply this diff:

-### 🌐 Truely Distributed Database
+### 🌐 Truly Distributed Database
@@
-This architecture enable EloqDoc to support:
+This architecture enables EloqDoc to support:

---

217-229: Clean up wording in the MinIO setup steps

A couple of small fixes here will improve clarity: correct the typo “exmaple” → “example” and use the plural verb for the credentials sentence (“credentials are”).

Apply this diff:

-**Step-4**, start a S3 emulator, takes `minio` as an exmaple.
+**Step-4**, start an S3 emulator—take `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`, whose default credentials are `minioadmin:minioadmin`.

---

126-126: Tighten the benchmark closing sentence

Polish the wording to read naturally: “We will publish more detailed benchmarks in the future.”

Apply this diff:

-We will publish a more detailed benchmarks in future.
+We will publish more detailed benchmarks in the future.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b827192 and 430ea62.

⛔ Files ignored due to path filters (5)

• images/eloqdoc_github_logov1.jpg is excluded by !**/*.jpg
• images/eloqdocarchitecture.jpg is excluded by !**/*.jpg
• images/eloqdocatlas16c150mro.jpg is excluded by !**/*.jpg
• images/eloqdocatlasfull16cro.jpg is excluded by !**/*.jpg
• images/eloqdocatlasfull16crw.jpg is excluded by !**/*.jpg

📒 Files selected for processing (1)

• README.md (4 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[grammar] ~9-~9: There might be a mistake here.
Context: ...nguage-C++-orange)](https://isocpp.org/) [![GitHub issues](https://img.shields.io...

(QB_NEW_EN)

---

[grammar] ~10-~10: There might be a mistake here.
Context: ...ps://github.com/eloqdata/eloqdoc/issues) [![Release](https://img.shields.io/badge...

(QB_NEW_EN)

---

[grammar] ~11-~11: There might be a mistake here.
Context: ...lue)](https://www.eloqdata.com/download) <a href="https://discord.com/invite/nmYj...

(QB_NEW_EN)

---

[grammar] ~12-~12: There might be a mistake here.
Context: ..."https://discord.com/invite/nmYjBkfak6"> <img alt="EloqDoc" src="https://img.shie...

(QB_NEW_EN)

---

[grammar] ~35-~35: There might be a mistake here.
Context: ... distributed performance and elasticity. --- ## Key Features ### ⚙️ MongoDB API Compati...

(QB_NEW_EN)

---

[grammar] ~45-~45: There might be a mistake here.
Context: ...nd. ### 🗃️ Tiered Storage Architecture EloqDoc seamlessly manages hot and cold ...

(QB_NEW_EN)

---

[grammar] ~49-~49: There might be a mistake here.
Context: ...e for frequently accessed data. ### 🌐 Truely Distributed Database Supports **multip...

(QB_NEW_EN)

---

[grammar] ~49-~49: There might be a mistake here.
Context: ...ata. ### 🌐 Truely Distributed Database Supports multiple writers and **fast...

(QB_NEW_EN)

---

[grammar] ~53-~53: There might be a mistake here.
Context: ... complexity. ### 🔄 Elastic Scalability - Scales compute and memory *100x faster...

(QB_NEW_EN)

---

[style] ~77-~77: This phrase is redundant. Consider writing “new”.
Context: ...ta.com/blog/2025/07/14/technology), the innovative new database foundation developed by EloqDa...

(INNOVATIVE_NEW)

---

[grammar] ~81-~81: There might be a mistake here.
Context: ... architecture enable EloqDoc to support: - Fast Scaling: Compute and memory scale...

(QB_NEW_EN)

---

[grammar] ~82-~82: There might be a mistake here.
Context: ... rapid elasticity for dynamic workloads. - Storage Flexibility: Storage scales se...

(QB_NEW_EN)

---

[grammar] ~94-~94: There might be a mistake here.
Context: ...hen the active dataset was fully cached. - For read-heavy applications, EloqDoc del...

(QB_NEW_EN)

---

[locale-violation] ~126-~126: The phrase ‘in future’ is British English. Did you mean: “in the future”?
Context: ...will publish a more detailed benchmarks in future. --- ## Quick Start ### Try EloqD...

(IN_FUTURE)

🪛 markdownlint-cli2 (0.18.1)

README.md

93-93: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}