Skip to content

fix(faq): correct Docker volume mount path and remove wordlist typo#468

Open
gkorland wants to merge 2 commits intomainfrom
fix/faq-docker-path-and-wordlist
Open

fix(faq): correct Docker volume mount path and remove wordlist typo#468
gkorland wants to merge 2 commits intomainfrom
fix/faq-docker-path-and-wordlist

Conversation

@gkorland
Copy link
Copy Markdown
Contributor

@gkorland gkorland commented May 4, 2026

Summary

Two bugs found during code review of the FAQ sections added in #464.

Changes

  • Fix Docker volume mount path in FAQ answers: operations/docker.md and operations/index.md FAQ answers incorrectly cited /var/lib/falkordb/data as the container data directory. Every runnable Docker/Docker Compose example in the same files uses /data (the FalkorDB container default). A user following the FAQ answer would silently get a misconfigured container with no persistence.
  • Remove UNIQIE from .wordlist.txt: This is a transposition typo for UNIQUE that was added to the spellcheck allowlist but doesn't appear in any source .md file. Leaving it whitelisted would silently allow the misspelling in future docs.

Testing

Spellcheck CI will verify the wordlist change is safe.

Related Issues

Follows up on #464

Summary by CodeRabbit

  • Documentation

    • Updated Docker configuration guidance for data persistence. Volume mounting instructions clarified to use /data instead of the previous path, with continued emphasis on enabling AOF for data durability and recovery across container restarts.
  • Chores

    • Removed invalid entries from internal wordlist.

- Fix FAQ answer in operations/docker.md and operations/index.md:
  change /var/lib/falkordb/data to /data to match all Docker Compose
  examples in the same file (FalkorDB container default data dir is /data)
- Remove 'UNIQIE' (typo for UNIQUE) from .wordlist.txt spellcheck allowlist

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 4, 2026

📝 Walkthrough

Walkthrough

This pull request contains two independent changes: removal of a misspelled wordlist entry and alignment of Docker data persistence documentation across two guides to use a consistent mount path.

Changes

Wordlist Cleanup

Layer / File(s) Summary
Typo Removal
.wordlist.txt
Removed misspelled entry UNIQIE from the wordlist, so undirected directly precedes unnormalized.

Docker Data Persistence Documentation

Layer / File(s) Summary
Mount Path Standardization
operations/docker.md, operations/index.md
Updated Docker volume mount path from /var/lib/falkordb/data to /data in FAQ persistence guidance across both documentation files while maintaining AOF enablement requirements.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Hopping through words with a careful eye,
Removing the typos that don't get by,
And smoothing the paths where data will stay,
A cleaner burrow for FalkorDB today! 🐰📝

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes: correcting Docker volume mount path and removing a wordlist typo. It accurately reflects the primary fixes in the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/faq-docker-path-and-wordlist

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

Copy link
Copy Markdown
Contributor

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@operations/index.md`:
- Line 69: The sentence "Mount a persistent volume to `/data` using Docker
volumes or bind mounts, and enable AOF persistence" in operations/index.md
conflicts with the Data Durability docs that reference `/var/lib/falkordb/data`;
update operations/index.md and the durability pages
(operations/durability/persistence.md and operations/durability/index.md) so
they use the same data directory path across all pages, or temporarily remove
the "See the [Data Durability](/operations/durability) guide for full details"
link from operations/index.md until the paths are synchronized; ensure the shown
mount path and any examples (AOF/config snippets) in functions/pages referencing
the data directory all match the chosen canonical path.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: bd4bf714-e2e1-42dc-a054-d469d26db6aa

📥 Commits

Reviewing files that changed from the base of the PR and between 1eda52c and 820f316.

📒 Files selected for processing (3)
  • .wordlist.txt
  • operations/docker.md
  • operations/index.md
💤 Files with no reviewable changes (1)
  • .wordlist.txt

Comment thread operations/index.md
a1="Use `falkordb/falkordb-server` for production deployments. It excludes the browser UI, making it lighter and more efficient. Use `falkordb/falkordb` for development when you need the built-in browser."
q2="How do I ensure my data survives container restarts?"
a2="Mount a persistent volume to `/var/lib/falkordb/data` using Docker volumes or bind mounts, and enable AOF persistence. See the [Data Durability](/operations/durability) guide for full details."
a2="Mount a persistent volume to `/data` using Docker volumes or bind mounts, and enable AOF persistence. See the [Data Durability](/operations/durability) guide for full details."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Line 69 links to contradictory persistence docs.

This answer now says mount to /data, but it also sends users to Data Durability “for full details,” where docs still show /var/lib/falkordb/data (see operations/durability/persistence.md lines 43-49 and 105-109, plus operations/durability/index.md lines 45-52). Please sync those pages (or temporarily remove this “full details” pointer) to avoid conflicting instructions that can break persistence setups.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@operations/index.md` at line 69, The sentence "Mount a persistent volume to
`/data` using Docker volumes or bind mounts, and enable AOF persistence" in
operations/index.md conflicts with the Data Durability docs that reference
`/var/lib/falkordb/data`; update operations/index.md and the durability pages
(operations/durability/persistence.md and operations/durability/index.md) so
they use the same data directory path across all pages, or temporarily remove
the "See the [Data Durability](/operations/durability) guide for full details"
link from operations/index.md until the paths are synchronized; ensure the shown
mount path and any examples (AOF/config snippets) in functions/pages referencing
the data directory all match the chosen canonical path.

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.

1 participant