docs: Fix documentation inaccuracies from review feedback#13
Conversation
Co-authored-by: zircote <307960+zircote@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR corrects documentation examples and references to better match Mnemonic’s current configuration locations, CLI syntax, and Python API signatures.
Changes:
- Align config/path references with XDG config (
~/.config/mnemonic/config.json) and unified memory store layout. - Update CLI examples for
gc,custodian, andvalidateto reflect existing commands/flags. - Fix API reference examples/signatures for relationships, ontology loading, and path helpers; remove references to non-existent tutorial files.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/tutorials/getting-started.md | Updates setup/status guidance and “Next steps” links to reflect current behavior and existing docs. |
| docs/tutorials/README.md | Removes links to non-existent tutorials and adjusts learning-path expectations accordingly. |
| docs/troubleshooting.md | Updates config path references and CLI examples for validation, GC, custodian, and debugging guidance. |
| docs/api-reference.md | Corrects multiple API examples/signatures and clarifies ontology/path resolution behavior. |
| ````python | ||
| from lib.paths import ( | ||
| get_memory_dir, | ||
| get_memory_path, | ||
| get_search_paths, | ||
| get_blackboard_dir, | ||
| get_all_memory_roots, | ||
| get_all_memory_roots_with_legacy, | ||
| ) |
There was a problem hiding this comment.
In this import list you switched to get_all_memory_roots_with_legacy and removed get_memory_path, but the code block below still calls get_memory_path(...) and get_all_memory_roots(). Since lib.paths does not expose convenience functions for those names, the example is now copy/paste-broken; update the snippet to use PathResolver.get_memory_path(...) and get_all_memory_roots_with_legacy() (or add/document the missing convenience wrappers).
| 1. Detect your current git remote to infer organization and project names | ||
| 2. Write global Mnemonic config to `~/.config/mnemonic/config.json` | ||
| 3. Create the unified memory store directory at the configured path (by default `~/.claude/mnemonic/{org}/{project}/`) | ||
| 4. Initialize the default ontology and index structures in that directory |
There was a problem hiding this comment.
The setup command does not write organization/project into ~/.config/mnemonic/config.json (it only stores version and memory_store_path), and it also doesn’t initialize a default ontology.yaml or any index structures. Please adjust these bullets to match /mnemonic:setup (commands/setup.md) behavior.
| ````bash | ||
| # Check user-level structure | ||
| tree -L 3 ~/.claude/mnemonic/ | ||
|
|
||
| # Check project-level structure | ||
| tree -L 2 .claude/mnemonic/ | ||
| # Check memory store structure for this project | ||
| tree -L 3 ~/.claude/mnemonic/your-org/your-project/ |
There was a problem hiding this comment.
Step 4 hardcodes the default ~/.claude/mnemonic/... path. Since /mnemonic:setup allows configuring memory_store_path, consider showing how to derive the path from ~/.config/mnemonic/config.json (or reference $STORE_PATH_EXPANDED/get_memory_root()), otherwise the verification step will be wrong for non-default setups.
| **Example output (will vary by project):** | ||
|
|
||
| ```` | ||
| ✓ Memory root: ~/.claude/mnemonic/ | ||
| ✓ Organization: your-org | ||
| ✓ Project: your-project | ||
| ✓ Ontology: loaded (.claude/mnemonic/ontology.yaml) | ||
| ✓ Git initialized | ||
| ✓ Total memories: 0 |
There was a problem hiding this comment.
The /mnemonic:status example output here doesn’t match the current /mnemonic:status command output format (commands/status.md prints sections like "=== Mnemonic Status ===" and doesn’t output these checkmark lines). Consider updating this example to reflect the actual output, or point readers at the sections/fields to look for instead of a literal block.
| 3. **[Building a Knowledge Base](knowledge-base.md)** - Create a comprehensive project knowledge base | ||
| 1. **[CLI Usage](../cli-usage.md)** - Learn all Mnemonic commands | ||
| 2. **[Ontologies Guide](../ontologies.md)** - Explore memory types and namespaces | ||
| 3. **[Architecture](../architecture.md)** - Create a comprehensive project knowledge base |
There was a problem hiding this comment.
The description for the Architecture link is misleading: docs/architecture.md explains Mnemonic’s design and components, not how to “Create a comprehensive project knowledge base”. Update the link description to reflect the content (e.g., understanding how Mnemonic works).
| 3. **[Architecture](../architecture.md)** - Create a comprehensive project knowledge base | |
| 3. **[Architecture](../architecture.md)** - Understand Mnemonic’s architecture and components |
| # Validate YAML syntax | ||
| python3 -c "import yaml; yaml.safe_load(open('.claude/mnemonic/ontology.yaml'))" | ||
|
|
||
| # Use validation tool | ||
| python3 tools/mnemonic-validate .claude/mnemonic/ontology.yaml | ||
| # Validate ontology file | ||
| /mnemonic:validate .claude/mnemonic/ontology.yaml |
There was a problem hiding this comment.
These ontology validation commands reference .claude/mnemonic/ontology.yaml, which only exists under the legacy scheme. With the unified store, project ontologies live under the configured memory store (e.g. ~/.claude/mnemonic/{org}/{project}/ontology.yaml), and /mnemonic:setup doesn’t create an ontology file by default. Update this section to reflect the correct file location(s) and/or how to find them via config + org/project.
e981dd1
into
docs/enhance-documentation-coverage-b12c1376691d75db
Corrects 23 documentation inaccuracies identified in PR #9 review where examples and references diverged from actual implementation.
Configuration & Paths
~/.claude/mnemonic/config.yaml→~/.config/mnemonic/config.json(XDG-compliant)config.memory_root→config.memory_store_pathCommand Syntax
/mnemonic:gc: Replaced non-existent flags (--older-than,--namespace) with actual (--dry-run,--archive,--compress)/mnemonic:custodian: Subcommands not flags (validate-links --fixnot--validate-links --fix)/mnemonic:status: Removed non-existent "Ontology: loaded" line from expected output/mnemonic:validate: Corrected usage for ontology validationAPI Documentation
add_relationship()signature:(memory_path, rel_type, target_id, label)not(source_path, target_id, rel_type, label)get_inverse()example: Valid MIF type"supersedes"not invalid"depends_on"get_ontology_file(): Clarified returns bundled MIF base, not custom ontologiesPathResolver.get_ontology_paths(): Excludes bundled base ontologyRelationship Types
Replaced invalid types with actual MIF spec types from lib/relationships.py:
Tutorial Content
Cleanup
make test-hooks,make test-lib)✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.