19964: Fix broken links in the documentation

[martin-augment]

19964: To review by AI

[gemini-code-assist]

Summary of Changes

Hello @martin-augment, 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 quality and maintainability of the project's documentation. It addresses and resolves various broken and outdated links, ensuring that users and contributors can access accurate and current information seamlessly. The changes span across multiple guides, correcting paths to internal documentation, external resources, and API references.

Highlights

• Documentation Link Corrections: Numerous internal and external links across various documentation files have been updated to ensure accuracy and prevent broken references, improving the overall navigability and reliability of the documentation.
• API Reference Path Updates: API documentation links for DataFusion and Apache Arrow components were corrected to reflect recent changes in module structure or re-exports within the libraries.
• External Resource Management: External resource links, including a download link for a SIGMOD paper and blog post domains, were fixed. An outdated blog post entry was also removed from the 'concepts-readings-events' guide.
• Version Reference Update: A version reference for DataFusion dependencies was updated from 25.0.0 to 26.0.0 in the example usage guide.

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

[coderabbitai]

Walkthrough

This pull request updates documentation files with corrected hyperlinks, reorganized reference paths, and version updates. Changes include redirecting internal API documentation links to reflect restructured module paths, removing obsolete reference links, updating external resource URLs with corrected domains and protocols, and bumping a DataFusion version reference from 25.0.0 to 26.0.0. All modifications are isolated to documentation files with no functional code or API surface changes.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[claude]

Pull Request Review

Summary

This PR fixes broken documentation links across multiple files. The changes update URLs that have become outdated due to documentation restructuring or API changes.

Code Quality ✅

Excellent - The changes are focused and precise:

• Each link update appears to correct the path to match current documentation/API structure
• Changes follow a consistent pattern of updating outdated paths
• No extraneous modifications

Changes Breakdown

1. Contributor Guide Link (howtos.md:190)

• Change: getting_started.html#protoc-installation → development_environment.html#protoc-installation
• Assessment: ✅ Correct - reflects documentation reorganization

2. API Documentation Links (extending-sql.md:337)

• Change: datafusion/sql/planner/trait.RelationPlannerContext.html → datafusion/logical_expr/planner/trait.RelationPlannerContext.html
• Assessment: ✅ Correct - reflects API module reorganization

3. Removed Dead Link (adding-udfs.md:586)

• Change: Removed reference to process_scalar_func_inputs
• Assessment: ✅ Good - better to remove than keep broken link

4. Multiple API Path Corrections (table-constraints.md:40-42)

• TableConstraint: Updated module path from sql/planner to logical_expr/sqlparser/ast
• Constraints: Updated path from common/functional_dependencies to common
• Field: Fixed typo datatype → datatypes
• Assessment: ✅ All correct

5. Arrow Array Type Links (arrow-introduction.md:229-230)

• Change: arrow-array/latest/arrow_array/array/struct.*Array → arrow/latest/arrow/array/type.*Array
• Assessment: ✅ Correct - reflects Arrow crate reorganization

6. Read Options Links (arrow-introduction.md:244-245)

• Change: execution/options/struct.*ReadOptions → datasource/file_format/options/struct.*ReadOptions
• Assessment: ✅ Correct - reflects API reorganization

7. External Resource Links (concepts-readings-events.md)

• PDF link: Changed domain from andrew.nerdnetworks.org/other/ to andrew.nerdnetworks.org/pdf/
• Blog links: Updated domain from blog.haoxp.xyz to blog.xiangpeng.systems
• Removed duplicate entry: Removed candle-image-segmentation entry
• Assessment: ✅ Good - these appear to be the updated/current URLs

8. Version Update (example-usage.md:106)

• Change: Updated example from DataFusion 25.0.0 to 26.0.0
• Assessment: ⚠️ Minor concern - This changes example version but not the Arrow version mentioned in the next line (still says 39.0.0 → 40.0.0). Should verify if DataFusion 26.0.0 actually uses Arrow 39.0.0 or if this example needs further updates.

Potential Issues

1. Version Consistency (example-usage.md)

The PR updates the DataFusion version from 25.0.0 to 26.0.0 but doesn't update the Arrow version dependencies mentioned in the example. Please verify:

• Does DataFusion 26.0.0 still use Arrow 39.0.0?
• Should the Arrow version in the example also be updated?

Recommendations

1. ✅ Verify Links: Consider adding a link checker to CI to catch broken links automatically in the future
2. ⚠️ Check Version Example: Verify the DataFusion 26.0.0 / Arrow 39.0.0 version pairing in example-usage.md is accurate

Test Coverage

N/A - Documentation-only changes. However, consider:

• Running a link checker tool to validate all updated URLs are accessible
• Checking that anchor links (e.g., #protoc-installation) actually exist on target pages

Security Concerns

✅ None - Documentation links only

Performance Considerations

✅ None - No code changes

Overall Assessment

LGTM with minor suggestion - This is a solid documentation maintenance PR. The link updates appear correct and well-researched. The only minor concern is ensuring the version example is fully consistent. Great work keeping the documentation current! 🎯

[gemini-code-assist]

Code Review

This pull request fixes several broken links in the documentation, which is a great improvement. Most of the changes are correct and improve the quality of the docs. I've found one small issue in docs/source/user-guide/example-usage.md where a version update has introduced an inconsistency in the dependency information. I've left a comment with a suggestion for a fix. Otherwise, the changes look good.

[gemini-code-assist]

While updating the DataFusion version to 26.0.0 is a good step, this change makes the following line about the required arrow version incorrect. According to crates.io, DataFusion 26.0.0 depends on arrow 40.0.0, not 39.0.0 as stated on the next line.

Please update the arrow versions on line 107 to maintain the example's accuracy. A correct statement would be:

For example, [DataFusion `26.0.0` dependencies] require `arrow`
`40.0.0`. If instead you used `arrow` `41.0.0` in your project you may
see errors such as:

[martin-augment]

value:useful; category:documentation; feedback:The Gemini AI reviewer is correct! If the example needs to use DataFusion 26.0.0 then the version of its arrow dependency should be increased too. DataFusion 26.0.0 depends on 40.0.0, not on 39.0.0.

[augmentcode]

🤖 Augment PR Summary

Summary: Fixes multiple broken links across the documentation by updating targets to current DataFusion/Arrow docs and external URLs.
Changes: Adjusts several docs.rs API reference paths (planners, constraints, Arrow types, read options), updates a few external resource/blog links, and refreshes the protoc install guide link.

_{🤖 Was this summary useful? React with 👍 or 👎}

[augmentcode]

Review completed. 1 suggestions posted.

Comment augment review to trigger a new review at any time.

[augmentcode]

This example says DataFusion 26.0.0 requires arrow 39.0.0, but docs.rs for datafusion 26.0.0 lists arrow ^40.0.0. This mismatch could mislead users trying to align dependency versions.

_{🤖 Was this useful? React with 👍 or 👎}

[martin-augment]

value:useful; category:documentation; feedback:The Augment AI reviewer is correct! If the example needs to use DataFusion 26.0.0 then the version of its arrow dependency should be increased too. DataFusion 26.0.0 depends on 40.0.0, not on 39.0.0.

[martin-augment]

8. Version Update (example-usage.md:106)

• Change: Updated example from DataFusion 25.0.0 to 26.0.0
• Assessment: ⚠️ Minor concern - This changes example version but not the Arrow version mentioned in the next line (still says 39.0.0 → 40.0.0). Should verify if DataFusion 26.0.0 actually uses Arrow 39.0.0 or if this example needs further updates.

value:useful; category:documentation; feedback:The Claude AI reviewer is correct! If the example needs to use DataFusion 26.0.0 then the version of its arrow dependency should be increased too. DataFusion 26.0.0 depends on 40.0.0, not on 39.0.0.