Skip to content

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

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 16, 2025
Merged

[docs]: improve docs structure #1623

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions doc/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

[Introduction](./README.md)
# Install & Usage
- [For kt-kernel](en/kt-kernel_intro.md)
- [For SFT](en/KTransformers-Fine-Tuning_User-Guide.md)
- [For kt-kernel](en/kt-kernel/kt-kernel_intro.md)
- [For SFT](en/SFT/KTransformers-Fine-Tuning_User-Guide.md)

# Tutorial
## 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

@gemini-code-assist gemini-code-assist bot Nov 16, 2025

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)

<!-- - [Multi-GPU Tutorial](en/multi-gpu-tutorial.md) -->
<!-- - [Use FP8 GPU Kernel](en/fp8_kernel.md) -->
<!-- - [Use AMD GPU](en/ROCm.md) -->
<!-- - [Deepseek-R1/V3 Show Case/Tutorial](en/DeepseekR1_V3_tutorial.md) -->
<!-- - [Why KTransformers So Fast](en/deepseek-v2-injection.md) -->
- [Injection Tutorial](en/injection_tutorial.md)
- [Multi-GPU Tutorial](en/multi-gpu-tutorial.md)
- [Use FP8 GPU Kernel](en/fp8_kernel.md)
- [Use AMD GPU](en/ROCm.md)
- [SFT developer tech notes](en/KTransformers-Fine-Tuning_Developer-Technical-Notes.md)

## KT-kernel part
<!-- # For Developer
- [Makefile Usage](en/makefile_usage.md) -->
Expand Down
0 ...-Fine-Tuning_Developer-Technical-Notes.md → ...-Fine-Tuning_Developer-Technical-Notes.md
View file
Open in desktop
File renamed without changes.
0 ...n/KTransformers-Fine-Tuning_User-Guide.md → ...T/KTransformers-Fine-Tuning_User-Guide.md
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions doc/en/SFT/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
#SFT Docs
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 16, 2025

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 doc/en/injection_tutorial.md → doc/en/SFT/injection_tutorial.md
View file
Open in desktop
File renamed without changes.
1 change: 1 addition & 0 deletions doc/en/kt-kernel/kt-kernel_intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
../../../kt-kernel/README.md
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Nov 16, 2025

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

1 change: 0 additions & 1 deletion doc/en/kt-kernel_intro.md
View file
Open in desktop

This file was deleted.