Skip to content

fix compile doc #392

Merged
thweetkomputer merged 1 commit intoeloqdata:mainfrom
thweetkomputer:mod_doc
Dec 23, 2025
Merged

fix compile doc #392
thweetkomputer merged 1 commit intoeloqdata:mainfrom
thweetkomputer:mod_doc

Conversation

@thweetkomputer
Copy link
Copy Markdown
Collaborator

@thweetkomputer thweetkomputer commented Dec 23, 2025

Summary by CodeRabbit

  • Documentation

    • Simplified and consolidated compilation instructions by eliminating variant-specific steps and consolidating multiple workflows into a unified, straightforward process for improved clarity
  • Chores

    • Updated submodule dependencies to latest versions with no functional impact

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Dec 23, 2025

Walkthrough

Documentation simplified by removing EloqDoc-RocksDBCloud-specific compilation instructions, consolidating guidance to EloqDoc-RocksDB only. Submodule pointer for data_substrate advanced to a newer commit with no detected functional changes.

Changes

Cohort / File(s) Summary
Documentation Simplification
docs/how-to-compile.md
Removed CLOUD variant compilation workflow, CLOUD-specific CMake and scons commands, CLOUD installation paths, and CLOUD prerequisites; consolidated remaining content to single EloqDoc-RocksDB flow
Submodule Update
src/mongo/db/modules/eloq/data_substrate
Updated pointer from commit 3c6efb6 to 7d44114; no API or functional changes detected

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • update subm #386 — Both PRs advance the same data_substrate submodule pointer to successive commits.
  • fix compile doc #276 — Both PRs simplify docs/how-to-compile.md by removing cloud-specific build configuration.
  • update submoulde #375 — Both PRs update the data_substrate submodule reference to different target commits.

Suggested labels

trigger-ci

Suggested reviewers

  • xiexiaoy
  • lzxddz

Poem

🐰 The clouds have drifted far away,
One simpler path now lights the day,
The substrate hops to heights anew,
With each update, the codebase grew! 🚀

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'fix compile doc' is vague and generic, using non-descriptive language that doesn't convey meaningful information about the specific changes made. Consider a more specific title that describes the actual change, such as 'Remove CLOUD variant compilation instructions from how-to-compile.md' or 'Simplify compilation docs by consolidating EloqDoc-RocksDB workflow'.
✅ 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 changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 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

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

@thweetkomputer thweetkomputer changed the title fix doc fix compile doc Dec 23, 2025
@thweetkomputer thweetkomputer merged commit 7867f03 into eloqdata:main Dec 23, 2025
2 checks passed
@thweetkomputer thweetkomputer deleted the mod_doc branch December 23, 2025 06:00
@coderabbitai coderabbitai bot mentioned this pull request Jan 12, 2026
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