docs: fix EVisRAG setup dir, TOC typo, and command continuation in README - #84
Open
lingmao233 wants to merge 1 commit into
Open
docs: fix EVisRAG setup dir, TOC typo, and command continuation in README#84lingmao233 wants to merge 1 commit into
lingmao233 wants to merge 1 commit into
Conversation
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
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
Three small README fixes:
git clone https://github.com/OpenBMB/VisRAG.gitthe working directory isVisRAG, but the instructions saycd EVisRAG, which fails withno such file or directory. Changed tocd VisRAG. (The conda env is still created and activated asEVisRAG— only the directory name was wrong.)#-licenseheading).generate.pyexample (--rank <process_rank> \), which breaks the continuation when the block is pasted into bash.How I verified
VisRAG) against thecdstep; the conda env name is unaffected since only thecdtarget changed.#-licensestill matches the# 📄 Licenseheading.