Skip to content

Conversation

@KMSorSMS
Copy link
Collaborator

What does this PR do?

Fixes #1620

Before submitting

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @KMSorSMS, 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 focuses on significantly improving the project's documentation structure by organizing existing and new documentation files into more logical and accessible subdirectories. The changes aim to enhance the overall navigability and maintainability of the documentation, particularly for SFT and kt-kernel related content, directly addressing issue #1620.

Highlights

  • Documentation Restructuring: The documentation for Supervised Fine-Tuning (SFT) and kt-kernel has been reorganized into dedicated subdirectories (SFT/ and kt-kernel/) to improve structure and logical grouping.
  • Updated Navigation: The main documentation index (doc/SUMMARY.md) has been updated to reflect the new file paths and introduce a hierarchical structure for SFT tutorials, making navigation more intuitive.
  • New SFT Entry Point: A new README.md file has been added within the doc/en/SFT/ directory, serving as a central entry point for all SFT-related documentation.
  • Refactored kt-kernel Introduction: The kt-kernel_intro.md file has been moved into its own doc/en/kt-kernel/ subdirectory, providing a clearer path to its content.
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.

@KMSorSMS KMSorSMS merged commit 133eea0 into kvcache-ai:main Nov 16, 2025
6 checks passed
@KMSorSMS KMSorSMS deleted the docs_refac branch November 16, 2025 04:41
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 reorganizes the documentation by moving files into SFT and kt-kernel subdirectories, which improves the structure. I've found a broken link in SUMMARY.md that needs to be fixed. I've also suggested some minor formatting improvements in the new markdown files for consistency and correctness.

## SFT part
- [SFT part](en/SFT/README.md)
- [SFT developer tech notes](en/SFT/KTransformers-Fine-Tuning_Developer-Technical-Notes.md)
- [Injection Tutorial](en/injection_tutorial.md)
Copy link
Contributor

Choose a reason for hiding this comment

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

high

The link to the "Injection Tutorial" appears to be incorrect. The file was moved to doc/en/SFT/injection_tutorial.md, but the link in this file still points to the old location en/injection_tutorial.md. This will result in a broken link.

Suggested change
- [Injection Tutorial](en/injection_tutorial.md)
- [Injection Tutorial](en/SFT/injection_tutorial.md)

@@ -0,0 +1 @@
#SFT Docs No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

There are a couple of minor formatting issues here:

  1. For the heading to be rendered correctly, there should be a space between the # and the text.
  2. It's a good practice to have a newline at the end of the file.
Suggested change
#SFT Docs
# SFT Docs

@@ -0,0 +1 @@
../../../kt-kernel/README.md No newline at end of file
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

It's a good practice to add a newline at the end of the file to prevent any potential issues with file processing tools.

Suggested change
../../../kt-kernel/README.md
../../../kt-kernel/README.md

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.

能否可以将文档整理一下,第一次学习真的有点费劲

1 participant