Skip to content

[DOC]: Fix broken links by pointing to local repository markdown files #2247

Description

@kabirvashisht4-glitch

How would you describe the priority of this documentation request

Medium

Please provide a link or source to the relevant docs

https://github.com/NVIDIA/NeMo-Retriever/blob/main/README.md

Location of the documentation

README.md in the repository root.

Describe the problem

Four specific hyperlinks under the "Documentation Resources" and contribution sections are currently returning 404 errors:

  1. Contributor Guide: The relative link points to contributing.md in lowercase. Because GitHub repository file paths are case-sensitive, this leads to a 404 since the actual file name in the root directory is CONTRIBUTING.md.
  2. Benchmarking Guide, MIG Deployment, and API Documentation: These external docs.nvidia.com paths are broken due to missing version tags or recent documentation path modifications following the 26.5.0 update.

Proposed changes

Update the broken links to point directly to their equivalent local markdown files within the repository to ensure they always resolve correctly, and fix the casing on the Contributor Guide.

1. Update Documentation Links to Local Repo Files

Change the following links in the Documentation Resources section:

  • Benchmarking Guide: Update to [Benchmarking Guide](evaluation/README.md) (or the equivalent local benchmarking markdown file).
  • MIG Deployment / API Documentation: Update these to point to the main nemo_retriever/README.md which now consolidates this framework configuration and client reference information.

2. Fix File Casing for Contributor Guide

  • Update relative link from contributing.md to CONTRIBUTING.md

Note: I would be happy to open a Pull Request to implement these fixes if the proposed changes look good to the team!

Metadata

Metadata

Assignees

No one assigned

    Labels

    docImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions