docs(cli): clarify that 'mempalace init' requires <dir> (#210)#862
Merged
bensig merged 1 commit intoMemPalace:developfrom Apr 15, 2026
Merged
Conversation
Fixes MemPalace#210. The CLI requires a positional <dir> argument. Previous docs emphasized that init 'sets up ~/.mempalace/' which misled users into expecting no arguments. Now the docs show <dir> is required, offer '.' as the usage for the current directory, and reword the description so the project-directory scan is listed first.
arnoldwender
requested review from
bensig,
igorls and
milla-jovovich
as code owners
igorls
added
documentation
bensig
approved these changes
Apr 15, 2026
Collaborator
bensig
left a comment
bensig
left a comment
There was a problem hiding this comment.
Code reviewed — no issues found. CLAUDE.md compliance verified.
igorls
added a commit
that referenced
this pull request
Apr 16, 2026
Advisor caught: initial boundary (962776c..develop) skipped PRs that landed on develop after v3.3.0 tag but before the sync-back merge. Adds entries for #871 MEMPAL_VERBOSE, #811 research() local-only default, #866 init .gitignore, #864 MCP stdout redirect, #863 precompact hook, #865 searcher empty results, #831 cold-start palace, #862 init help, #815 Slack provenance, #840 save hook auto-mine. Also drops the awkward caveat on #846 created_at — it's post-v3.3.0.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and Why
Closes #210. The reporter ran
mempalace initwith no argument and hiterror: the following arguments are required: dir, because the docs led themto believe
initjust sets up~/.mempalace/.Root Cause
Two doc locations de-emphasized the required positional
<dir>:website/reference/cli.md— the "What it does" list made "Creates~/.mempalace/config directory" sound like the primary effect ofinit, without reinforcing that<dir>is required.website/guide/getting-started.md— the Quick Start walked straight intomempalace init ~/projects/myappwithout noting that a directory argument is mandatory.Change Summary
website/reference/cli.md— mark<dir>as Required, addmempalace init .as the current-directory usage, re-order the "What it does" list so scanning<dir>is listed first, and add a short note about the argparse error users see when they forget the argument.website/guide/getting-started.md— add a one-line note that<dir>is required, showmempalace init .as an alternative, and soften "Sets up" to "Ensures … exists" to avoid implying init's only job is creating the global dir.No CLI/code changes — this is a documentation-only PR and does not conflict with #857 (init directory creation/normalization).
Test Plan
<dir>is now unambiguously requiredmempalace initwith no arg (expected behavior kept; docs now match)Closes #210