|
@@ -2,14 +2,14 @@
|
|
|
|
|
|
image:https://github.com/jMonkeyEngine/wiki/workflows/Build%20Docs/badge.svg[Status Badge, 175, 25]
|
|
|
|
|
|
-see link:https://wiki.jmonkeyengine.org/[https://github.com/jMonkeyEngine/wiki]
|
|
|
+see link:https://wiki.jmonkeyengine.org/docs/[https://github.com/jMonkeyEngine/wiki]
|
|
|
|
|
|
The project to store, edit, and generate the documentation of http://jmonkeyengine.org[jMonkeyEngine].
|
|
|
|
|
|
The documentation `docs/modules/ROOT/pages` is editable :
|
|
|
|
|
|
* Online via github (Edit link located on the top navbar of the Wiki + Pull Request)
|
|
|
-* Offline with the Atom editor, which includes a built in previewer and code editor. see link:https://wiki.jmonkeyengine.org/wiki/atom_editor.html[Atom Editor for Wiki Editing],
|
|
|
+* Offline with the Atom editor, which includes a built in previewer and code editor. see link:https://wiki.jmonkeyengine.org/docs/wiki/atom_editor.html[Atom Editor for Wiki Editing],
|
|
|
* Any text editor and browser program of your choice.
|
|
|
* Setting up your own local Node.js environment.
|
|
|
|
|
@@ -39,7 +39,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_header.html[Anatomy of a Wiki Header]
|
|
|
+** see link:https://wiki.jmonkeyengine.org/docs/wiki/wiki_header.html[Anatomy of a Wiki Header]
|
|
|
. 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 link:https://docs.antora.org/antora/2.3/[Antora Docs].
|
|
|
. You can create modules and submit them here also.
|
|
|
. When linking to other Wiki pages located in the `ROOT` module, always use an "`Inter-Document Cross Reference`" with the format,
|
|
@@ -79,7 +79,7 @@ See link:http://asciidoctor.org/docs/user-manual/#images[http://asciidoctor.org/
|
|
|
```
|
|
|
link:{link-javadoc}/com/jme3/app/state/BaseAppState.html[BaseAppState]
|
|
|
```
|
|
|
-** see link:https://wiki.jmonkeyengine.org/wiki/wiki_header.html[Anatomy of a Wiki Header] for details on how to override this setting.
|
|
|
+** see link:https://wiki.jmonkeyengine.org/docs/wiki/wiki_header.html[Anatomy of a Wiki Header] for details on how to override this setting.
|
|
|
|
|
|
== Build & Preview
|
|
|
|