-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[docs]: improve docs structure #1623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
| - [Injection Tutorial](en/injection_tutorial.md) | |
| - [Injection Tutorial](en/SFT/injection_tutorial.md) |
| @@ -0,0 +1 @@ | |||
| #SFT Docs No newline at end of file | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| @@ -0,0 +1 @@ | |||
| ../../../kt-kernel/README.md No newline at end of file | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does this PR do?
Fixes #1620
Before submitting