Contribute to manual

What can I do?

You now have three ways to contribute to the writing of the manual.

• Translate content into your own language

• Report a content error, submit Issue on Github

• Submit new content using Pull Request

Being a translator

In writing the manual, the administrator found that most of the people in Discord are not native English speakers, so the complex English tutorials make it difficult for them to read. You can use translation software to first translate the English content into your own language, then embellish it with spoken language and finally make the manual accessible to a wider audience.

You can do this by changing the file directly and submitting a Pull Request for translation.

Get a Github Account

You can sign up for a free Github account with your own email address and contribute to the manual.

Click to view the tutorial.

Open the HMCL-PE manual's github Page

Click on the button to copy the file to your account

But don't tick this function!

Then,Create your version of the Manual.

Click on Button

You will then be automatically redirected to your own version.

Starting Translation!

First, switch to the language branch you want to translate into.

If your native language is not among the supported languages, you can let me create a branch by @mc_shengxia at Discord, or by submitting an Issue on Github.

What can I do before translate a text document?

Before proceeding with the translation you need to know the following:

• Calibrate the HMCL-PE community manual for new versions

If this is the case then there is no new version, otherwise you need to click Update Branch to update

• Please do not translate the names of any folders as this could easily result in the site not being able to read the files.

How do I translate the SUMMARY?

All you need to do is find SUMMARY.md and edit it.

Please do not change the name of the folder, it does not work.

The sections marked in blue like this are the names of the headings of each section, and also the names of the subheadings.

The parts marked in red like this are the paths to the read files, please do not translate them.

How to translate?

All you need to do is open a file and click the button.

After translate,you need to Slide to the bottom of the page and click on the button

How do I submit my translation to the community?

Once you have edited the file, you will see that the appearance looks like this.

All you have to do is click the button to submit your Pull Request to the community!

If you follow the manual tutorial for translation, you do not need to change here.

If you follow the manual tutorial for translation, you do not need to change here.

You can make a note here to explain what you have translated.

If you don't want your request to be returned by the maintainer because of some minor formatting gaps, you'd better enable this feature:

Finally, all you have to do is click the button and you're done!

Be an issue reporter

You can learn how to submit an issue by clicking here. Go to Github and submit your first Issue.

Be a content creator

You can do what the manual says in this section, you can also go check here for more help (WIP)