minetest_doc_example/README.md

# Example mod for the Help modpack (`doc`, `doc_items`, etc.)
This mod is for modders and useless for anyone else.
It demonstrates the usage of the APIs of the Help mods. This should help you
in getting started with this modpack.
This example mod does not demonstrate everything, only the most
frequently-needed features to help you get started. For most use cases, this
knowledge might already suffice. You do not need to understand everything to
use this modpack.
Read `API.md` of the respective mods to learn how to use the Help mods
properly.

Using the APIs of the Help modpack helps to improve the overall quality
and completeness of the entire help.

This mod includes examples for the following mods:

* `doc_items`: In `doc_items.lua`.
         For adding item help (including nodes). Start here!
* `doc_identifier`: In `doc_identifier.lua`.
         This is for adding lookup tool support for custom entities.
* `doc`: In `doc.lua`, for adding your own categories and entries.
         This is rather heavy stuff, intended for advanced modding.
         But is also very flexible.

Activate this mod in your world to see some example categories, entries and
items added.

Read the source code files in this mod for some brief explanations.