Mirrorlandia_minetest/minetest_docs
1
0
Fork 0
mirror of https://github.com/minetest/minetest_docs.git synced 2024-07-02 14:20:22 +02:00
Code Issues Packages Projects Releases Wiki Activity

Small fixes

Browse Source
This commit is contained in:
GreenXenith 2022-01-11 00:32:37 -08:00
parent 775203d8de
commit 96a5c6f7a9
2 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HOWTO.adoc
View File

@ -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[]

6
templates/standard.adoc
View File

@ -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 <<Vehicle Properties, Vehicle properties>>.
|===
==== Returns
[%autowidth, frame=none]
|===
| `vehicle` | `Vehicle` | The created vehicle.
| `vehicle` | `Vehicle` | The created vehicle.
|===
.Creating a Vehicle