Mooncake icon indicating copy to clipboard operation
Mooncake copied to clipboard

[Documentation]: What's the difference between doc and docs?

Open stmatengss opened this issue 2 months ago • 12 comments

Documentation Feedback

Merging these directories would reduce maintenance overhead. Should we proceed?

Before submitting a new issue...

  • [ ] Make sure you already searched for relevant issues and read the documentation

stmatengss avatar Nov 14 '25 15:11 stmatengss

Agree. Should we merge all the doc/en to docs?

ykwd avatar Nov 15 '25 04:11 ykwd

Agree. Should we merge all the doc/en to docs?

We can add it to #414

stmatengss avatar Nov 17 '25 12:11 stmatengss

Good documentation is an essential part of a successful community. I'd like to take on this task and expect to provide an RFC next week. @stmatengss @ykwd

Keithwwa avatar Nov 18 '25 03:11 Keithwwa

Good documentation is an essential part of a successful community. I'd like to take on this task and expect to provide an RFC next week. @stmatengss @ykwd

Thank you for offering to contribute! Just to make sure we're on the same page, could you share a bit more about what you’re planning to work on? For example, are you thinking about merging doc/en into docs, or focusing on improving the existing documentation content?

ykwd avatar Nov 18 '25 04:11 ykwd

Thank you for offering to contribute! Just to make sure we're on the same page, could you share a bit more about what you’re planning to work on? For example, are you thinking about merging doc/en into docs, or focusing on improving the existing documentation content?

My initial idea is to merge doc/en into docs, remove duplicates, and categorize new content, with the goal of having all internal links in Readme redirect to blog. Does this meet your needs?

Keithwwa avatar Nov 18 '25 10:11 Keithwwa

Thank you for offering to contribute! Just to make sure we're on the same page, could you share a bit more about what you’re planning to work on? For example, are you thinking about merging doc/en into docs, or focusing on improving the existing documentation content?

My initial idea is to merge doc/en into docs, remove duplicates, and categorize new content, with the goal of having all internal links in Readme redirect to blog. Does this meet your needs?

Sure — this sounds great. I believe your plan will definitely help improve the quality of our documentation. Looking forward to it!

ykwd avatar Nov 18 '25 11:11 ykwd

Thank you for offering to contribute! Just to make sure we're on the same page, could you share a bit more about what you’re planning to work on? For example, are you thinking about merging doc/en into docs, or focusing on improving the existing documentation content?

My initial idea is to merge doc/en into docs, remove duplicates, and categorize new content, with the goal of having all internal links in Readme redirect to blog. Does this meet your needs?

Cool, I'll add it to our roadmap. Feel free to take it on if you're interested.

stmatengss avatar Nov 19 '25 14:11 stmatengss

I have an idea: to reduce the effort of writing documents in both Chinese and English, we could introduce AI to assist with synchronization. After that, when updates are needed, we'd only have to write in one language. This is an example.

staryxchen avatar Nov 19 '25 15:11 staryxchen

I have an idea: to reduce the effort of writing documents in both Chinese and English, we could introduce AI to assist with synchronization. After that, when updates are needed, we'd only have to write in one language. This is an example.

Could you help merge the documents? Although it is tough work, I believe we must finish it soon. @staryxchen

stmatengss avatar Nov 25 '25 05:11 stmatengss

I have an idea: to reduce the effort of writing documents in both Chinese and English, we could introduce AI to assist with synchronization. After that, when updates are needed, we'd only have to write in one language. This is an example.

Could you help merge the documents? Although it is tough work, I believe we must finish it soon. @staryxchen

I'd like to take on this task, but has @Keithwwa already started working on it? Additionally, I believe we can merge the doc and docs folders first. The contents within can remain unchanged for now, as some information may become obsolete after the new version of Mooncake is released.

staryxchen avatar Nov 25 '25 06:11 staryxchen

I have an idea: to reduce the effort of writing documents in both Chinese and English, we could introduce AI to assist with synchronization. After that, when updates are needed, we'd only have to write in one language. This is an example.

Could you help merge the documents? Although it is tough work, I believe we must finish it soon. @staryxchen

I'd like to take on this task, but has @Keithwwa already started working on it? Additionally, I believe we can merge the doc and docs folders first. The contents within can remain unchanged for now, as some information may become obsolete after the new version of Mooncake is released.

Agree. We can discuss the details in Slack. @Keithwwa @staryxchen

stmatengss avatar Nov 25 '25 16:11 stmatengss

@stmatengss @Keithwwa I'll make some preliminary changes (merge doc/ into docs/) in #1133 , and we can refine them together next.

staryxchen avatar Nov 27 '25 13:11 staryxchen