Skip to content

Conversation

@AlexSkrypnyk
Copy link
Member

@AlexSkrypnyk AlexSkrypnyk commented Feb 9, 2026

Summary by CodeRabbit

  • Documentation
    • Updated database operations documentation with new instructions for executing fetch and export commands through direct host scripts.
    • Revised environment variable naming and usage patterns for database operations.

@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

Walkthrough

Documentation updates to database setup instructions, replacing Docker Compose-based command examples with direct host script execution examples. Environment variable naming updated from VORTEX_DB_DOWNLOAD_REFRESH to VORTEX_DB_DOWNLOAD_FRESH across Fetching and Exporting sections.

Changes

Cohort / File(s) Summary
Database Documentation
.vortex/docs/content/development/database.mdx
Updated Fetching and Exporting sections to use direct host script invocations (./scripts/vortex/...) instead of Docker Compose commands. Renamed environment variable from VORTEX_DB_DOWNLOAD_REFRESH to VORTEX_DB_DOWNLOAD_FRESH and updated tab labels from Docker Compose to Host.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 The docs have hopped from Docker's nest,
To scripts that run their very best,
A fresh new name, a simpler way,
Direct execution saves the day! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fixed database docs' is vague and generic. While it references documentation, it does not clearly specify what was fixed or what the primary changes entail. Consider using a more descriptive title that specifies the actual changes, such as 'Update database docs to use host scripts instead of Docker Compose' or 'Replace Docker Compose invocations with direct script execution in database docs'.
✅ 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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature/fix-docs-database

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

Copy link

@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: 1

🤖 Fix all issues with AI agents
In @.vortex/docs/content/development/database.mdx:
- Around line 25-32: The "Fetching database" section uses a TabItem with
value="host" label="Host" and direct ./scripts/vortex/download-db.sh usage while
the "Refreshing database" section still shows Docker Compose commands; make the
tab naming and command style consistent by updating the "Refreshing database"
section to use a TabItem with value="host" label="Host" and replace docker
compose exec cli commands with the equivalent host-script invocation (e.g.,
./scripts/vortex/refresh-db.sh or the same scripts/vortex/download-db.sh flow),
or alternatively change the "Fetching database" TabItem to "Docker
Compose"/docker commands—ensure TabItem values/labels (value="host"/label="Host"
or value="docker-compose"/label="Docker Compose") and the commands inside each
TabItem match across both sections.

Comment on lines +25 to 32
<TabItem value="host" label="Host">
```shell
# Download latest database dump (uses cache if downloaded today)
docker compose exec cli ./scripts/vortex/download-db.sh
./scripts/vortex/download-db.sh
# Force a fresh download regardless of cache
VORTEX_DB_DOWNLOAD_REFRESH=1 docker compose exec cli ./scripts/vortex/download-db.sh
VORTEX_DB_DOWNLOAD_FRESH=1 ./scripts/vortex/download-db.sh
```
</TabItem>
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Inconsistent tab naming across sections.

The "Fetching database" section now uses the "Host" tab with direct script execution, but the "Refreshing database" section (lines 60-67) still uses "Docker Compose" tab with docker compose exec cli commands. This creates an inconsistent documentation experience.

Consider updating the "Refreshing database" section to match this approach, or vice versa, so users have a consistent experience across all sections.

🤖 Prompt for AI Agents
In @.vortex/docs/content/development/database.mdx around lines 25 - 32, The
"Fetching database" section uses a TabItem with value="host" label="Host" and
direct ./scripts/vortex/download-db.sh usage while the "Refreshing database"
section still shows Docker Compose commands; make the tab naming and command
style consistent by updating the "Refreshing database" section to use a TabItem
with value="host" label="Host" and replace docker compose exec cli commands with
the equivalent host-script invocation (e.g., ./scripts/vortex/refresh-db.sh or
the same scripts/vortex/download-db.sh flow), or alternatively change the
"Fetching database" TabItem to "Docker Compose"/docker commands—ensure TabItem
values/labels (value="host"/label="Host" or value="docker-compose"/label="Docker
Compose") and the commands inside each TabItem match across both sections.

@github-actions
Copy link

github-actions bot commented Feb 9, 2026

Code Coverage Report:
  2026-02-09 04:50:24

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-02-09 04:50:26

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-02-09 04:53:54

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@AlexSkrypnyk
Copy link
Member Author

Code Coverage Report:
  2026-02-09 04:54:20

 Summary:
  Classes:  0.00% (0/1)
  Methods:  0.00% (0/2)
  Lines:   93.92% (170/181)

@codecov
Copy link

codecov bot commented Feb 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.44%. Comparing base (78811df) to head (687c3bf).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2259      +/-   ##
==========================================
- Coverage   76.95%   76.44%   -0.51%     
==========================================
  Files         112      107       -5     
  Lines        5870     5829      -41     
  Branches       44        0      -44     
==========================================
- Hits         4517     4456      -61     
- Misses       1353     1373      +20     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@AlexSkrypnyk AlexSkrypnyk merged commit af79fd1 into main Feb 9, 2026
34 of 35 checks passed
@AlexSkrypnyk AlexSkrypnyk deleted the feature/fix-docs-database branch February 9, 2026 05:28
@github-project-automation github-project-automation bot moved this from BACKLOG to Release queue in Vortex Feb 9, 2026
@AlexSkrypnyk AlexSkrypnyk added this to the 1.36.0 milestone Feb 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Release queue

Development

Successfully merging this pull request may close these issues.

1 participant