[WIP]chore: restructure documentation directory

[staryxchen]

• Move documentation files from doc/ to docs/source/ directory
• Reorganize English and Chinese documentation files

Description

Type of Change

• Types
  • Bug fix
  • New feature
    • Transfer Engine
    • Mooncake Store
    • Mooncake EP
    • Integration
    • P2P Store
    • Python Wheel
  • Breaking change
  • CI/CD
  • Documentation update
  • Other

How Has This Been Tested?

N/A

Checklist

• I have performed a self-review of my own code.
• I have updated the documentation.
• I have added tests to prove my changes are effective.

[gemini-code-assist]

Summary of Changes

Hello @staryxchen, 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 a significant refactoring of the project's documentation directory structure. The primary goal is to centralize and standardize the location of all source documentation files, improving overall organization and maintainability. This change lays the groundwork for a clearer and more scalable documentation system.

Highlights

• Documentation Restructuring: All existing documentation files have been moved from the doc/ directory to a new docs/source/ directory, creating a more organized structure.
• Language-Specific Organization: English and Chinese documentation files, previously located under doc/en/ and doc/zh/ respectively, are now consistently organized under docs/source/en/ and docs/source/zh/.

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

[gemini-code-assist]

Code Review

This pull request restructures the documentation by moving files from doc/ to docs/source/. While the changes are primarily file moves, I've taken the opportunity to review the content of the moved documentation files. My review includes feedback on broken image links, typos, grammatical errors, and inconsistencies that I found. Addressing these issues will improve the quality and clarity of the documentation.

[stmatengss]

After merging doc and docs, we should verify the website links remain valid across all projects. CC. @ShangmingCai @ykwd

[ykwd]

I'm not sure if it's because this is still a work in progress, but in the current PR it looks like the doc files were simply moved into the docs directory.

In fact, most of the content in doc/en and docs is duplicated, so if it’s just a relocation, it doesn’t seem very meaningful. It would be better to merge the content together.

[ykwd]

Another question. Will we continue to maintain doc/zh in the future?

[staryxchen]

I'm not sure if it's because this is still a work in progress, but in the current PR it looks like the doc files were simply moved into the docs directory.

In fact, most of the content in doc/en and docs is duplicated, so if it’s just a relocation, it doesn’t seem very meaningful. It would be better to merge the content together.

Yes, I just merge doc/ into docs/ without changing any content now, I will keep on working on it.

[staryxchen]

Another question. Will we continue to maintain doc/zh in the future?

I think we just retain a few necessary documents in chinese is enough.

[stmatengss]

Another question. Will we continue to maintain doc/zh in the future?

I think we just retain a few necessary documents in chinese is enough.

Agree with that.

[ykwd]

Another question. Will we continue to maintain doc/zh in the future?

I think we just retain a few necessary documents in chinese is enough.

LGTM

[Keithwwa]

In fact, we only need to keep a small portion of the documents in the doc folder; the rest of the content is duplicated with that in the docs folder and should be deleted. In addition, since we are only keeping the content in the docs folder, should we no longer retain the Chinese content? @staryxchen @stmatengss @ykwd

[ykwd]

In fact, we only need to keep a small portion of the documents in the doc folder; the rest of the content is duplicated with that in the docs folder and should be deleted. In addition, since we are only keeping the content in the docs folder, should we no longer retain the Chinese content? @staryxchen @stmatengss @ykwd

As discussed above, we can retain the existing doc/zh, perhaps in the doc/zh menu as an archive.

[Keithwwa]

In fact, we only need to keep a small portion of the documents in the doc folder; the rest of the content is duplicated with that in the docs folder and should be deleted. In addition, since we are only keeping the content in the docs folder, should we no longer retain the Chinese content? @staryxchen @stmatengss @ykwd

As discussed above, we can retain the existing doc/zh, perhaps in the doc/zh menu as an archive.

Generally, we don't recommend users obtain information directly from .md files, but rather through the documents website, as its directory structure is clearer and it provides search functionality. Furthermore, the vllm and sgalng do not retain Chinese documentation, perhaps because Google Chrome already offers convenient webpage translation features : >

Based on the initial discussion[#1060 ], the ideal document should look like this ：[#1153 ] please help review it~