Skip to content
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

Docs: Format document #155

Open
yuluo-yx opened this issue Jan 25, 2024 · 7 comments
Open

Docs: Format document #155

yuluo-yx opened this issue Jan 25, 2024 · 7 comments
Assignees

Comments

@yuluo-yx
Copy link
Contributor

yuluo-yx commented Jan 25, 2024

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
@LinuxSuRen
Copy link
Owner

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

@yuluo-yx
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

@LinuxSuRen
Copy link
Owner

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.

@yuluo-yx
Copy link
Contributor Author

Very happy to contribute to this. 💪

@yuluo-yx
Copy link
Contributor Author

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
Copy link
Contributor Author

image

image

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants