Skip to content

docs(xvla): fix broken local file links in documentation#3291

Open
kuafou wants to merge 1 commit intohuggingface:mainfrom
kuafou:fix/xvla-docs
Open

docs(xvla): fix broken local file links in documentation#3291
kuafou wants to merge 1 commit intohuggingface:mainfrom
kuafou:fix/xvla-docs

Conversation

@kuafou
Copy link
Copy Markdown

@kuafou kuafou commented Apr 6, 2026

Title

docs(xvla): fix broken local file links in documentation

Type / Scope

  • Type: Docs
  • Scope: xvla

Summary / Motivation

This PR fixes incorrect local file paths in the XVLA documentation.
Previously, some links pointed to absolute local paths (e.g., /home/...), which are not accessible to users and result in broken links.

This change replaces those paths with valid GitHub URLs to improve usability and documentation quality.

Related issues

  • N/A

What changed

  • Replaced local file paths with GitHub links in:

    • docs/source/xvla.mdx
  • Updated references to:

    • action_hub.py
    • processor_xvla.py
    • configuration_xvla.py

How was this tested (or how to run locally)

  • Manually verified that all updated links are accessible via browser
  • Confirmed that links correctly point to the corresponding files in the repository

Checklist (required before merge)

  • Linting/formatting run (pre-commit run -a)
  • All tests pass locally (pytest)
  • Documentation updated
  • CI is green

Reviewer notes

  • This is a documentation-only fix with no impact on code behavior
  • Main focus is ensuring all links are valid and user-accessible

@github-actions github-actions bot added the documentation Improvements or fixes to the project’s docs label Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or fixes to the project’s docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant