Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the common pitfalls #48

Open
kneekoo opened this issue May 27, 2023 · 2 comments
Open

Document the common pitfalls #48

kneekoo opened this issue May 27, 2023 · 2 comments
Labels
Content Alterations or additions to written content

Comments

@kneekoo
Copy link

kneekoo commented May 27, 2023

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
Copy link
Member

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

@appgurueu
Copy link
Contributor

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.

@wsor4035 wsor4035 transferred this issue from minetest/minetest_docs Dec 15, 2024
@JosiahWI JosiahWI added the Content Alterations or additions to written content label Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content Alterations or additions to written content
Projects
None yet
Development

No branches or pull requests

4 participants