diff --git a/HOWTO.adoc b/HOWTO.adoc index 3ed6724..26e1a8d 100644 --- a/HOWTO.adoc +++ b/HOWTO.adoc @@ -1,4 +1,5 @@ = How to Write Good Documentation +include::include/config.adoc[] This guide will attempt to help you avoid common documentation issues and help you get your point across as clearly as possible. @@ -74,6 +75,7 @@ See link:templates/standard.adoc[standard template] for an example. * `config.adoc`: Global doc configuration. * `types.adoc`: Lua types formatted as `type-name` linked to the Lua PIL. Example: `{type-string}`. + All types should link somewhere at some point (cross-reference or outside). +* `footer.adoc`: Footer for every documentation page. === Functions ---- @@ -121,3 +123,5 @@ All types should link somewhere at some point (cross-reference or outside). * `another_property:` `type` ** A description. ---- + +include::include/footer.adoc[] diff --git a/templates/standard.adoc b/templates/standard.adoc index 776a88d..9ebbf8b 100644 --- a/templates/standard.adoc +++ b/templates/standard.adoc @@ -5,7 +5,7 @@ include::../include/types.adoc[] :keywords: standard, template This is the standard template of how a good AsciiDoc should be structured. -This pragraph describes the purpose of the document. +This paragraph describes the purpose of the document. In this example, an imaginary API for a vehicle will be documented. == Vehicle Properties @@ -28,14 +28,14 @@ vehicle = Vehicle.new(pos, properties) ==== Arguments [%autowidth, frame=none] |=== -| `pos` | `{class-vector}` | The position at which the vehicle will be spawned. +| `pos` | `{class-vector}` | The position at which the vehicle will be spawned. | `properties` | `{type-table}` | A list of <>. |=== ==== Returns [%autowidth, frame=none] |=== -| `vehicle` | `Vehicle` | The created vehicle. +| `vehicle` | `Vehicle` | The created vehicle. |=== .Creating a Vehicle