fix: correct clone URL in README Quickstart#198
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates the README.md by correcting the repository URL and directory names to XortexAI/XMem, standardizing markdown emphasis syntax, and improving whitespace formatting. Review feedback identifies a missing directory change command in the Chrome Extension installation section that could lead to user errors and notes an inconsistency in the FALLBACK_ORDER configuration format compared to other documentation sections.
| git clone https://github.com/XortexLabs/xmem.git | ||
| cd xmem | ||
| git clone https://github.com/XortexAI/XMem.git | ||
| cd XMem |
There was a problem hiding this comment.
While updating the directory name to XMem here is correct, the 'Install the Chrome Extension' section (lines 331-333) is also missing a cd xmem-extension command after cloning. Users following these steps sequentially will still be inside the XMem directory, which will cause the npm install command in the next step to fail. It would be best to add the missing cd command to that section as well to ensure the Quickstart remains functional.
|
|
||
| > [!TIP] | ||
| > For a fully local setup with no cloud dependencies: | ||
| > |
There was a problem hiding this comment.
The example value for FALLBACK_ORDER in the tip ('["ollama"]') uses a JSON list format, which is inconsistent with the comma-separated format shown in the configuration table at line 370. While Pydantic-settings can often parse JSON strings for list types, using a simple comma-separated string (e.g., FALLBACK_ORDER=ollama) is more standard for .env files and matches the documentation elsewhere in this file. This inconsistency might lead to validation errors if the string is not parsed as expected by the validate_fallback_order check in src/config/settings.py.
|
| Filename | Overview |
|---|---|
| README.md | Fixes incorrect clone URL and directory name in Quickstart; also cleans up whitespace and normalises italic markdown syntax. |
Sequence Diagram
sequenceDiagram
participant U as User
participant GH as GitHub (XortexAI/XMem)
Note over U,GH: Before fix — wrong org/case
U->>GH: git clone https://github.com/XortexLabs/xmem.git
GH-->>U: ❌ Repository not found
Note over U,GH: After fix — correct org/case
U->>GH: git clone https://github.com/XortexAI/XMem.git
GH-->>U: ✅ Clone succeeds → directory XMem/
U->>U: cd XMem
Reviews (1): Last reviewed commit: "FIX: correct clone URL in README Quickst..." | Re-trigger Greptile
|
Thank you for the contribution @nihalsheikh |
Summary
XortexLabs/xmem.git→XortexAI/XMem.gitcd xmem→cd XMemto match the actual cloned directory nameCloses #
Testing
Notes
Closes #197