|
|
@@ -4,7 +4,7 @@ image:https://travis-ci.org/jMonkeyEngine/wiki.svg?branch=master["Build Status",
|
|
|
|
|
|
= jMonkeyEngine Documentation
|
|
|
|
|
|
-see link:https://wiki.jmonkeyengine.org/wiki/documentation[https://wiki.jmonkeyengine.org/wiki/documentation]
|
|
|
+see link:https://wiki.jmonkeyengine.org/documentation[https://wiki.jmonkeyengine.org/documentation]
|
|
|
|
|
|
The project to store, edit, and generate the documentation of http://jmonkeyengine.org[jMonkeyEngine].
|
|
|
|
|
|
@@ -12,7 +12,7 @@ The documentation (<<src/docs/asciidoc>>) is editable :
|
|
|
|
|
|
* online via github (Edit button located at top of the Wiki page + Pull Request)
|
|
|
* offline with Netbeans after local `git clone` + open
|
|
|
-* offline with Atom editor, see link:https://wiki.jmonkeyengine.org/wiki/wiki/atom_editor.html[Atom Editor for Wiki Editing]
|
|
|
+* offline with Atom editor, see link:https://wiki.jmonkeyengine.org/wiki/atom_editor.html[Atom Editor for Wiki Editing]
|
|
|
|
|
|
.Prerequisites
|
|
|
. Have a link:https://github.com/[GitHub account].
|
|
|
@@ -41,7 +41,7 @@ There are a few simple rules to follow when contributing.
|
|
|
|
|
|
. It's not required but it's a good idea to give a heads up you made a P/R on the link:https://hub.jmonkeyengine.org/[jMonkeyEngine Forum] under the `Documentation` topic.
|
|
|
. When adding documents, make sure to always complete the header of your document first.
|
|
|
-** see link:https://wiki.jmonkeyengine.org/wiki/wiki/wiki_header.html[Anatomy of a Wiki Header]
|
|
|
+** see link:https://wiki.jmonkeyengine.org/wiki/wiki_header.html[Anatomy of a Wiki Header]
|
|
|
. When linking to other Wiki pages, always use an "`Inter-Document Cross Reference`" with the format,
|
|
|
** ++<<path/to/wiki/page#,custom label text>>++ +
|
|
|
The `#` sign substitutes for the file extension. This type of link will first look for the `.adoc` file and if not found default to the `.html` version.
|
mitm