search

minetest / minetest_docs

Minetest Engine documentation (Work in progress. Meanwhile, please refer to lua_api.txt and dev.minetest.net)
Other
22 stars 13 forks source link

Document the common pitfalls #51

Open kneekoo opened 1 year ago

kneekoo commented 1 year ago

The documentation will likely always lag behind the latest version of the engine, and not everything is thoroughly documented in the first place. But considering that games and mods have various issues related to improper API usage, impacting both players and contributors, a guide covering the most common pitfalls would be very useful.

So instead of sharing empty criticism about how some games and mods are "broken beyond repair", a guide to addressing common issues is the mature thing to do. This helps the entire ecosystem.

rubenwardy commented 1 year ago

here's a start: https://rubenwardy.com/minetest_modding_book/en/quality/common_mistakes.html

appgurueu commented 1 year ago

That's what the [footgun] tag in the issue tracker here would be for.

I'm not sure where we should have a document of "just footguns". The original idea was to just use the appropriate DANGER / WARNING admonitions for docs documenting the relevant features.