Skip to content

fix: update op docs index and remove outdated op doc#910

Merged
HYLcool merged 2 commits intomainfrom
fix/docs
Feb 10, 2026
Merged

fix: update op docs index and remove outdated op doc#910
HYLcool merged 2 commits intomainfrom
fix/docs

Conversation

@cmgzn
Copy link
Collaborator

@cmgzn cmgzn commented Feb 10, 2026

Fix sphinx homepage rendering issues caused by README.md and op's markdown files updates

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @cmgzn, I'm Gemini Code Assist1! 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 issues with the Sphinx documentation rendering, particularly on the homepage. It streamlines the documentation structure by removing an obsolete operator document and updating index references to ensure correct navigation. Additionally, it simplifies the main index files to prevent rendering problems stemming from recent README.md changes, improving the overall consistency and functionality of the documentation site.

Highlights

  • Documentation Cleanup: Removed the outdated documentation file for general_fused_op.md.
  • Sphinx Index Updates: Modified both English and Chinese Sphinx documentation indices (docs_index.rst, docs_index_ZH.rst) to correctly reference the pipeline operator documentation instead of the op directory.
  • Homepage Rendering Fixes: Simplified the main Sphinx index files (index.rst, index_ZH.rst) by removing specific start-after directives and other metadata, which resolves rendering issues caused by README.md updates.

🧠 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
  • docs/operators/op/general_fused_op.md
    • Removed the entire documentation file as it was outdated.
  • docs/sphinx_doc/source/docs_index.rst
    • Updated the reference for operator documentation from 'docs/operators/op/index' to 'docs/operators/pipeline/index'.
  • docs/sphinx_doc/source/docs_index_ZH.rst
    • Updated the reference for Chinese operator documentation from 'docs/operators/op/index' to 'docs/operators/pipeline/index'.
  • docs/sphinx_doc/source/index.rst
    • Removed _Data Processing for and with Foundation Models: reference.
    • Removed raw-html-m2r role definition.
    • Removed navigation links ([中文主页], [DJ-Cookbook], etc.).
    • Removed Data Processing for and with Foundation Models heading.
    • Removed :start-after: # Data Processing for and with Foundation Models directive from README.md inclusion.
  • docs/sphinx_doc/source/index_ZH.rst
    • Removed _Data Processing for and with Foundation Models: reference.
    • Removed raw-html-m2r role definition.
    • Removed navigation links ([英文主页], [DJ-Cookbook], etc.).
    • Removed Data Processing for and with Foundation Models heading.
    • Removed :start-after: # Data Processing for and with Foundation Models directive from README_ZH.md inclusion, and changed README_ZH.md to README.md.
Activity
  • No human activity has been recorded on this pull request yet.
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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request aims to fix documentation rendering issues by updating Sphinx index files and removing an outdated document. The changes are mostly correct, such as updating operator paths and cleaning up index files. However, I've noticed that the Chinese documentation index (index_ZH.rst) now points to the English README.md file, which will likely cause the wrong language to be displayed on the Chinese homepage. I've left a suggestion to correct this.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@cmgzn cmgzn requested a review from yxdyc February 10, 2026 08:12
@cmgzn cmgzn changed the title [WIP] fix: update op docs index and remove outdated op doc fix: update op docs index and remove outdated op doc Feb 10, 2026
@HYLcool HYLcool merged commit a7c75c5 into main Feb 10, 2026
3 of 5 checks passed
@yxdyc yxdyc deleted the fix/docs branch February 12, 2026 09:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants