open-source-best-practice icon indicating copy to clipboard operation
open-source-best-practice copied to clipboard

Docs: Format document

Open yuluo-yx opened this issue 1 year ago • 7 comments

now, in https://linuxsuren.github.io/open-source-best-practice/.

There are some problems with mixing Chinese and English and formatting problems

e.g.:

The number of spaces before and after them should be consistent. image

There are some punctuation issues: image

yuluo-yx avatar Jan 25 '24 02:01 yuluo-yx

hi @yuluo-yx , thanks for reporting this issue. Please feel free to help to fix it if you are interested in it.

LinuxSuRen avatar Jan 25 '24 02:01 LinuxSuRen

hi @yuluo-yx , thanks for reporting this issue. Please feel free to help to fix it if you are interested in it.

It's a great honor, I will submit a PR soon to fix it, please assign to me @LinuxSuRen

yuluo-yx avatar Jan 25 '24 02:01 yuluo-yx

I have an idea. In open source best practice projects, most of the content is displayed in text. We can establish a set of specifications for writing documents to provide reference when writing documents to avoid these problems.

yuluo-yx avatar Jan 25 '24 02:01 yuluo-yx

I have an idea. In open source best practice projects, most of the content is displayed in text. We can establish a set of specifications for writing documents to provide reference when writing documents to avoid these problems.

Of course, it could be wonderful if you could take the initiative to make a start. It is crucial to encourage greater collaboration among all stakeholders in this project.

I have a new idea. We could also convert the Markdown files into a PDF. And publish it in GitHub release.

LinuxSuRen avatar Jan 25 '24 02:01 LinuxSuRen

Very happy to contribute to this. 💪

yuluo-yx avatar Jan 25 '24 02:01 yuluo-yx

I have a new idea. We could also convert the Markdown files into a PDF. And publish it in GitHub release.

A good idea, we can write a roadmap document for this to record some of our ideas and implement them later. 😄

yuluo-yx avatar Jan 25 '24 02:01 yuluo-yx

image

image

In this case, it should be a problem with the page display. The file format is normal when viewed in the editor.

yuluo-yx avatar Jan 26 '24 14:01 yuluo-yx