Skip to content

fix: correct clone URL in README Quickstart#198

Open
nihalsheikh wants to merge 1 commit into
XortexAI:mainfrom
nihalsheikh:fix/readme-clone-url
Open

fix: correct clone URL in README Quickstart#198
nihalsheikh wants to merge 1 commit into
XortexAI:mainfrom
nihalsheikh:fix/readme-clone-url

Conversation

@nihalsheikh
Copy link
Copy Markdown

@nihalsheikh nihalsheikh commented May 23, 2026

Summary

  • Fixed incorrect clone URL in the Quickstart section of README.md
  • Changed XortexLabs/xmem.gitXortexAI/XMem.git
  • Fixed cd xmemcd XMem to match the actual cloned directory name

Closes #

Testing

  • Ran the corrected clone command locally and confirmed it succeeds

Notes

  • Docs-only change, no code or tests affected

Closes #197

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

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.

Comment thread README.md
git clone https://github.com/XortexLabs/xmem.git
cd xmem
git clone https://github.com/XortexAI/XMem.git
cd XMem
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

Comment thread README.md

> [!TIP]
> For a fully local setup with no cloud dependencies:
>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

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.

@nihalsheikh nihalsheikh deleted the fix/readme-clone-url branch May 23, 2026 04:23
@nihalsheikh nihalsheikh restored the fix/readme-clone-url branch May 23, 2026 04:24
@nihalsheikh nihalsheikh reopened this May 23, 2026
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 23, 2026

Greptile Summary

Corrects the git clone URL in the README Quickstart section from github.com/XortexLabs/xmem.git to github.com/XortexAI/XMem.git and updates the follow-up cd command to match the resulting directory name.

  • Clone URL fix: XortexLabs/xmem.gitXortexAI/XMem.git and cd xmemcd XMem, so users running the Quickstart commands get a working setup.
  • Minor cleanup: extra blank lines removed, italic markers normalised from *...* to _..._, and blank continuation lines added inside the TIP blockquote for correct rendering.

Confidence Score: 5/5

Docs-only change; no code, tests, or configuration affected.

The change corrects a broken clone URL and matching directory name in the Quickstart guide, along with minor whitespace and markdown style cleanup. The fix is verified by the author running the command locally, and the repository name aligns with the repo context (xortexai/xmem). There is no risk of introducing regressions.

No files require special attention.

Important Files Changed

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
Loading

Reviews (1): Last reviewed commit: "FIX: correct clone URL in README Quickst..." | Re-trigger Greptile

@ishaanxgupta
Copy link
Copy Markdown
Member

Thank you for the contribution @nihalsheikh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

FIX: Broken clone URL in README Quickstart

2 participants