Fix doc links and add tests

[tastelikefeet]

PR type

• Bug Fix
• New Feature
• Document Updates
• More Models or Datasets Support

PR information

Write the detail information belongs to this PR.

Experiment results

Paste your experiment result here(if needed).

[gemini-code-assist]

Summary of Changes

Hello @tastelikefeet, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on enhancing the reliability and maintainability of the project's documentation. It addresses several issues with broken or incorrectly formatted links and introduces automated testing to prevent similar problems in the future. The primary goal is to ensure that all documentation references are accurate and accessible, thereby improving the user experience and reducing future maintenance overhead.

Highlights

• Documentation Link Fixes: Several broken or outdated links within the documentation and README files have been corrected to point to the correct resources or use appropriate relative paths.
• New Markdown Link Validation Test Suite: A comprehensive test suite has been added to automatically validate markdown links across the documentation. This includes checks for HTTP link accessibility, correct GitHub branch usage ('main'), and proper markdown link formatting.
• Improved Documentation Structure: The README_ZH.md file now uses a relative path for its quick start guide link, improving consistency and maintainability.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• .github/copilot-instructions.md
  • Updated Ray Serve demo configuration and startup instructions.
  • Added an alternative endpoint URL for the Ray Serve demo.
• README_ZH.md
  • Corrected the link to the Chinese quick start guide to use a relative path.
• docs/README.md
  • Updated a PyTorch documentation link example for Conv1d.
• docs/source_en/Usage Guide/NPU-Support.md
  • Adjusted table formatting for component requirements to improve readability.
• tests/docs/init.py
  • Added copyright header to the new test directory.
• tests/docs/test_markdown_links.py
  • Introduced a new test file to validate markdown links in documentation.
  • Implemented functions to find markdown files, extract links, and classify link types.
  • Added tests to ensure no local relative links point outside the docs directory.
  • Included a test to verify all GitHub links use the 'main' branch.
  • Provided an optional test to check the accessibility of HTTP/HTTPS links.
  • Added a test to validate markdown link formatting, specifically checking for spaces after ](.
  • Included an informational test to summarize link types found in the documentation.
  • Added a specific test for HTTP links in README files.

Activity

• The pull request was opened to address bug fixes and document updates.
• New test files were added to introduce automated link validation for markdown documentation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request primarily focuses on fixing documentation links and introducing a new test suite to validate markdown links, which is a great addition for maintaining documentation quality. The changes are generally good, but I've identified a couple of areas in the updated documentation that could be clearer. I've also suggested some improvements to the new link validation script to make it more robust.