From 62de30904bd36ca57d6130579879e4dedc20b28f Mon Sep 17 00:00:00 2001 From: Xeno333 Date: Wed, 11 Jun 2025 21:21:58 -0500 Subject: [PATCH] Improve descriptions --- doc/README.md | 38 +++++++++++++++++++++++--------------- 1 file changed, 23 insertions(+), 15 deletions(-) diff --git a/doc/README.md b/doc/README.md index b641f6cd4..3351148a3 100644 --- a/doc/README.md +++ b/doc/README.md @@ -1,29 +1,37 @@ # Documentation Index -The following is a list of documentation files and a brief description to aid -in locating documentation (sorted alphabetically). +The following is a list of documentation files and a brief description, if + applicable, to aid in locating documentation (sorted alphabetically + per-section). ## Lua -- [Builtin Entities](builtin_entities.md): Documentation of core engine entities. -- [Client-side API](client_lua_api.md): Documentation on client side lua API - enviorment. -- [Formspec Toolkit API](fst_api.txt): Documentation on formspec toolkit. -- [Menu API](menu_lua_api.md): Documentation lua API for menu enviorment. -- [Mod API](lua_api.md): Documentation on lua API for mod enviorment. +- [Builtin Entities](builtin_entities.md): Internal predefined engine entities. +- [Client-side API](client_lua_api.md): Client side enviorment's Lua API. +- [Formspec Toolkit API](fst_api.txt) +- [Menu API](menu_lua_api.md): Lua API for the creation of engine menus, not the + mod API. +- [Mod APIs](lua_api.md): Lua APIs avalible within the mod enviorment and mapgen + enviorment. Contains infromation related to texturing and structure of games, + mods, and texture packs. **Related**: [Texture Packs](texture_packs.md) and + [World Format](world_format.md). ## Formats and Content -- [Texture Packs](texture_packs.md): Documentation on Luanti's texture packs system. -- [World Format](world_format.md): Documentation on Luanti world format. +- [Texture Packs](texture_packs.md): Layout and description of Luanti's texture + packs structure and configuration. Related information can be found in the + [mod API](lua_api.md). +- [World Format](world_format.md): Layout and description of Luanti's world + format. Documents the structure of the dirrectories and the files therein, + including the structure of the internal world related databases. ## Protocals -- [Protocol](protocol.txt): Documentation on Luanti's network protocol. +- [Protocol](protocol.txt): *Rough* outline of Luanti's network protocol. ## Misc. -- [Android information](android.md): Documentation relating to Luanti on the Android platform. -- [Docker Server](docker_server.md): Documentation on Luanti's Docker server. -- [Luanti Development Direction](direction.md): Official Luanti development direction information. -- [Major Breakages List](breakages.md): Documentation of breaking changes. \ No newline at end of file +- [Android Information](android.md) +- [Docker Server](docker_server.md) +- [Luanti Development Direction](direction.md) +- [List of Major Breakages](breakages.md) \ No newline at end of file