Skip to content

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.

Sign up for GitHub

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

Merged
AlexSkrypnyk merged 1 commit into from
Feb 9, 2026
+5 −5
Merged

Fixed database docs. #2259

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .vortex/docs/content/development/database.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ download the latest database dump into the `.data` directory.
ahoy fetch-db --fresh
```
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<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>
Comment on lines +25 to 32
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot Feb 9, 2026

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.

</Tabs>
Expand Down Expand Up @@ -84,10 +84,10 @@ Export timestamped database dumps from the local environment.
ahoy export-db
```
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<TabItem value="host" label="Host">
```shell
# Export current database to .data directory
docker compose exec cli ./scripts/vortex/export-db.sh
./scripts/vortex/export-db.sh
```
</TabItem>
</Tabs>
Expand Down