Skip to content

Comments

Fixing all broken links in integrate_hardware document#1445

Merged
CarolinePascal merged 5 commits intohuggingface:mainfrom
arulloomba1:fix_hardware_doc
Jul 25, 2025
Merged

Fixing all broken links in integrate_hardware document#1445
CarolinePascal merged 5 commits intohuggingface:mainfrom
arulloomba1:fix_hardware_doc

Conversation

@arulloomba1
Copy link
Contributor

What this does

This PR fixes broken links in the Bring Your Own Hardware documentation and the integrate_hardware.mdx file by replacing outdated or incorrect file paths with absolute URLs that point to the correct locations in the GitHub repository.

These relative links previously led to 404 Not Found errors in both the GitHub file preview and Hugging Face documentation pages. By updating the links to absolute paths, we ensure they remain valid even as the project structure evolves.

Examples:
All broken links under Bring Your Own Hardware and integrate_hardware.mdx have been updated. For example:

  • Before:
    https://github.com/huggingface/lerobot/blob/main/lerobot/robots/robot.py
    
  • After:
    https://github.com/huggingface/lerobot/blob/main/src/lerobot/robots/robot.py
    

These changes fix documentation that was otherwise unusable due to dead links.

How it was tested

  • I committed the changes to a personal fork.
  • I opened each modified documentation file in GitHub preview mode.
  • I manually clicked through each link to ensure all now resolve to the correct file paths on GitHub’s main branch.

There are no code or CLI changes — this is a documentation-only PR.

Examples:
n/a (documentation)

How to checkout & try? (for the reviewer)

  • Go to the Files changed tab in this PR.
  • Use your browser's search to locate a few updated paths, such as:
    • src/lerobot/robots/robot.py
  • Click each link in the Markdown preview and confirm that they lead to the correct file on GitHub (not a 404 page).
  • If you want to preview it locally:
doc-builder preview lerobot docs/source/

Examples:
as above

Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
@CarolinePascal
Copy link
Collaborator

Hi @arulloomba1,

Thanks for fixing these typos ! Would it be possible for you to update the link to record.py in il_robots.mdx as well ? I'll merge everything once it's done :)

Best,

Caroline.

@CarolinePascal CarolinePascal added bug Something isn’t working correctly documentation Improvements or fixes to the project’s docs labels Jul 9, 2025
@CarolinePascal CarolinePascal self-requested a review July 9, 2025 14:09
@arulloomba1
Copy link
Contributor Author

arulloomba1 commented Jul 10, 2025

Yes @CarolinePascal , will do it right away!
update: done

arulloomba1 and others added 3 commits July 10, 2025 14:23
Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@CarolinePascal CarolinePascal merged commit dacd1d7 into huggingface:main Jul 25, 2025
9 checks passed
andrearosasco pushed a commit to andrearosasco/lerobot that referenced this pull request Jul 25, 2025
)

Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
AdilZouitine pushed a commit that referenced this pull request Aug 10, 2025
Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
milong26 pushed a commit to milong26/lerobot_diy that referenced this pull request Aug 26, 2025
)

Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
Ricci084 pushed a commit to JeffWang987/lerobot that referenced this pull request Sep 5, 2025
)

Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
BillmanH pushed a commit to BillmanH/lerobot that referenced this pull request Sep 7, 2025
)

Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
fracapuano pushed a commit that referenced this pull request Sep 12, 2025
Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
sandhya-cb pushed a commit to sandhya-cb/lerobot-clutterbot that referenced this pull request Jan 28, 2026
)

Signed-off-by: arulloomba1 <145633197+arulloomba1@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn’t working correctly documentation Improvements or fixes to the project’s docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants