Fixing broken internal links

[aireilly]

Fixed some broken links

[gemini-code-assist]

Summary of Changes

Hello @aireilly, 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 addresses and resolves several broken internal links within the project's main documentation file, docs/index.md. The primary goal is to enhance the user experience by ensuring that all references to examples and other documentation sections are functional and lead to the correct content. The changes involve standardizing link formats to use absolute paths and simplifying some links to point to general example directories rather than specific files.

Highlights

• Documentation Link Fixes: Corrected several internal links within docs/index.md to ensure proper navigation and accessibility of referenced examples and sections.
• Path Standardization: Updated relative link paths to use absolute paths (starting with /), improving consistency and robustness of the documentation links.
• Link Simplification: Simplified links that previously pointed to specific example files (e.g., quip_example.py) to now point directly to their respective example directories (e.g., /examples/transform), making the documentation cleaner and more maintainable.

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. ↩

[github-actions]

👋 Hi! Thank you for contributing to llm-compressor. Please add the ready label when the PR is ready for review.

Note: This is required to complete the testing suite, please only add the label once the PR is code complete and local testing has been performed.

[gemini-code-assist]

Code Review

This pull request fixes several broken or suboptimal internal links in the main documentation page. The changes correctly update relative links to absolute ones and point to directory-level READMEs instead of specific code files, which improves the documentation structure. I've identified a couple of places where the links could be made even more specific by pointing to section anchors within the target pages, which would enhance user navigation. My detailed suggestions are in the comments below.

[shanjiaz]

Thanks for fixing!