Skip to content

fix: correct clone URL in README Quickstart#198

Open
nihalsheikh wants to merge 2 commits into
XortexAI:mainfrom
nihalsheikh:fix/readme-clone-url
Open

fix: correct clone URL in README Quickstart#198
nihalsheikh wants to merge 2 commits 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 Outdated
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

This PR makes documentation-only edits to README.md: removes a redundant blank line, converts two inline italic markers from *text* to _text_ style, adds a blank line before the benchmark section, and fixes empty-line handling inside a >[!TIP] callout block.

  • The PR description claims to fix an incorrect git clone URL (XortexLabs/xmem.gitXortexAI/XMem.git) and cd xmemcd XMem in the Quickstart section, but neither change appears in the actual diff.
  • The Quickstart section still contains cd xmem (line 316); if npx create-xmem@latest scaffolds a directory named XMem, this command fails on case-sensitive filesystems.

Confidence Score: 4/5

Safe to merge as-is since all actual changes are cosmetic formatting, but the Quickstart cd xmem command may be wrong on case-sensitive systems and the described fixes were never applied.

The diff contains only whitespace and markdown formatting changes that carry no functional risk. However, the PR description advertises two concrete documentation fixes that are entirely absent from the diff — the cd xmem directory name on line 316 remains unchanged, and no git clone command exists in the Quickstart section. If npx create-xmem@latest scaffolds a directory named XMem, the existing cd xmem will silently fail for users on Linux.

README.md lines 314–318 — the Quickstart bash block should be verified: confirm whether the scaffolded directory is xmem or XMem and update accordingly.

Important Files Changed

Filename Overview
README.md Formatting-only changes (blank lines, italic syntax, blockquote spacing) merged in; the clone URL and cd directory fixes described in the PR are absent from the diff

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md diff] --> B{Change type}
    B --> C[Blank line removed lines 11-12]
    B --> D[Italic syntax *text* to _text_ lines 136 140]
    B --> E[Blank line added before benchmark section line 306]
    B --> F[Empty blockquote lines added inside TIP callout lines 371-374]
    B --> G{Claimed in PR description}
    G --> H[git clone URL fix XortexLabs to XortexAI - Not in diff]
    G --> I[cd xmem to cd XMem - Not in diff - Line 316 still says cd xmem]
Loading

Comments Outside Diff (1)

  1. README.md, line 314-318 (link)

    P1 Stated fix not applied — cd xmem still present

    The PR description says it changed cd xmemcd XMem to match the actual cloned directory name, but the diff does not contain this change and line 316 still reads cd xmem. On case-sensitive filesystems (Linux), if npx create-xmem@latest creates a directory named XMem, the cd xmem command will fail with "No such file or directory". The PR description also mentions fixing a git clone URL (XortexLabs/xmem.gitXortexAI/XMem.git), but there is no git clone command anywhere in the Quickstart section — so that fix either targets the wrong section or was never applied.

    Fix in Cursor Fix in Codex Fix in Claude Code

Fix All in Cursor Fix All in Codex Fix All in Claude Code

Reviews (2): Last reviewed commit: "Merge branch 'main' into fix/readme-clon..." | Re-trigger Greptile

@ishaanxgupta
Copy link
Copy Markdown
Member

Thank you for the contribution @nihalsheikh

@ishaanxgupta
Copy link
Copy Markdown
Member

@nihalsheikh please fix the merge conflicts

@nihalsheikh
Copy link
Copy Markdown
Author

Hey @ishaanxgupta I've resolved the merge conflicts and accepted the incoming changes from main for both the Quickstart section (now using npx create-xmem@latest) and the new Context Portability section. The branch should be clean now. Thanks for the patience and for approving the PR!

@ishaanxgupta
Copy link
Copy Markdown
Member

I think the changes are fixed as I dont see updation of commands in your PR

@nihalsheikh
Copy link
Copy Markdown
Author

When resolving the merge conflicts, I accepted the incoming changes from main for the Quickstart section, which replaced the old git clone block (that my fix targeted) with the new npx create-xmem@latest approach. Since main had already moved past the git clone method entirely, the original URL fix became moot. Feel free to close this PR if it no longer adds value.

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