-
-
Notifications
You must be signed in to change notification settings - Fork 28
Fixed database docs. #2259
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fixed database docs. #2259
Conversation
WalkthroughDocumentation updates to database setup instructions, replacing Docker Compose-based command examples with direct host script execution examples. Environment variable naming updated from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this 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.
| <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> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
|
|
|
|
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Summary by CodeRabbit