Wiki Contributions

Prerequisites

  1. Have a GitHub account.

  2. Optional: Are a Wiki project member.

If you are not a member, you can fork the repository into your GitHub account and issue pull requests via github.

To fork the Wiki repository into your GitHub Account:

  • In the menu at the top of the docs.jmonkeyengine.org page, select the Fork button.

The syntax is asciidoctor:

An easy to use primer for GitHub commands can be found here:

Contribute

The wiki is an Antora documentation site. There are a few simple rules to follow when contributing.

  1. It’s not required but it’s a good idea to give a heads up you made a P/R on the jMonkeyEngine Forum under the Documentation topic.

  2. When adding documents, make sure to always complete the header of your document first.

  3. The docs are modular so you can create your own Antora site playbook and module and it can be included in the wiki and maintained by you.
    See: Antora Docs.
    You can create modules and submit them here also.

It is recommended that you read at least these paragraphs to inform yourself on how to build pages and submit them for review to the wiki.