docs: fix broken links in READMEs and documentation - #1599
Open
1183531403-art wants to merge 1 commit into
Open
Conversation
All replacement targets were verified to return HTTP 200 before use: - README_zh.md: the BGE-M3 report PDF lives at research/BGE_M3/BGE_M3.pdf, not under FlagEmbedding/BGE_M3/ - docs/source/bge/bge_m3.rst: correct the arXiv id for the BGE-M3 paper (2402.03216, drop the stray trailing 's') - docs/source/C-MTEB.rst: C_MTEB moved under research/ - examples/finetune/reranker/README.md: the pretrain data format section moved to research/old-examples/pretrain - research/README.md: point the LLM Embedder heading, the reranker fine-tune example, and the LLM reranker fine-tune link at their current locations
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
1 participant
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.
Found by scanning every markdown/rst file in the repo (180 files, 356 unique external URLs) and checking each one live. These were genuinely dead (404 verified before the fix); every replacement target was verified to return HTTP 200 before use:
README_zh.mdblob/master/FlagEmbedding/BGE_M3/BGE_M3.pdfblob/master/research/BGE_M3/BGE_M3.pdfdocs/source/bge/bge_m3.rstarxiv.org/pdf/2402.03216s(stray trailings)arxiv.org/pdf/2402.03216docs/source/C-MTEB.rsttree/master/C_MTEBtree/master/research/C_MTEBexamples/finetune/reranker/README.mdtree/master/examples/pretrain#2-data-formattree/master/research/old-examples/pretrain#2-data-format(anchor kept, section exists)research/README.mdtree/master/FlagEmbedding/llm_embeddertree/master/research/llm_embedderresearch/README.mdtree/master/examples/rerankertree/master/examples/finetune/rerankerresearch/README.mdtree/master/FlagEmbedding/llm_reranker#fine-tunetree/master/research/llm_reranker#fine-tune(anchor## Fine-tuneexists)After the change, all 81 URLs in the five touched files were re-checked live; all resolve (the only remaining oddity is a pre-existing line in
README_zh.mdwhere a Chinese closing bracket sits flush against the MemoRAG arXiv URL — left untouched since the URL itself works).Happy to split this per-directory if you prefer smaller patches.