MinetestWiki:Lua API Wiki Documentation Cleanup

From Minetest Developer Wiki
Revision as of 06:38, 29 July 2021 by Wuzzy (talk | contribs) (→‎The problem: outdated→updated)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The Minetest Developer Wiki is being plagued by a large number of outdated pages, most of which are pending deletion. This page lists information about what needs to be done.

The problem

A huge amount of pages about the Lua API are outdated. Most of the content has bee just copied from the official documentation at one day, and unsurprisingly never updated since then (because it was a shitty idea to begin with, who's going to manually update the whole wiki just to duplicate lua_api.txt?). This is VERY bad, as it gives reader the illusion of official info, when in fact, the fake documentation of the functions on this wiki are NOT official.

For example, the pages about Lua AP functions/methos are the worst. There is a huge amount of pages about functions. Note that ALL of them are considered to be unofficial. So besically, this wiki is a bit in a mess right now.

Solution

Ideally, all the offending pages are deleted. And never, mass-copy stuff from lua_api.txt again.

Regarding Lua API documentation, this wiki should merely link to the official documentation, i.e. lua_api.txt.

Currently, a few pages (NOT ALL OF THEM!) have been marked with the UnofficialLua template. This warns readers that such pages should not be taken seriously. See Category:UnofficialLua for a list.

Prominent offending pages about the Lua API

Cleanup TODO list

  • Add the “UnofficialLua” template to pages that include content that is mostly ripped from lua_api.txt.
  • Figure out how to mass-delete pages
  • Delete all of the offending pages
  • Make sure we have highly-visible links to the TRUE documentation
  • Remove 4 category links (Methods, Objects, Types, Misc) from the Sidebar. Needs sysop privileges ... :(

How pages should be deleted

  • All pages with the UnofficialLua template should be deleted
  • All pages in one of these categories should be deleted: Category:Methods, Category:Objects, Category:Types
  • All of the “prominent pages” listed above should be deleted