neoforged / Documentation

The repository containing Neo's documentation

MIT License

23 stars 36 forks source link

Describe type + reason introduced in NeoForge 20.4.40-beta #37

Closed shartte closed 6 months ago

shartte commented 6 months ago

See https://github.com/neoforged/FancyModLoader/pull/51

Preview URL: https://pr-37.neoforged-docs-previews.pages.dev

neoforged-pages-deployments[bot] commented 6 months ago

Deploying with Cloudflare Pages

Name	Result
Last commit:	7dd0f7bddab3a2c5306117fe15835528dcb2e426
Status:	✅ Deploy successful!
Preview URL:	https://1e24e4b1.neoforged-docs-previews.pages.dev
PR Preview URL:	https://pr-37.neoforged-docs-previews.pages.dev

IchHabeHunger54 commented 6 months ago

Looks good in general. Three minor nitpicks:

Please remove the "Replaced the mandatory field in NeoForge 20.4.40-beta". We assume people reading the docs to be on latest NeoForge.
AFAICT the type value must be encased in "" (this is not the case in the example).
Please add a simple example for the reason, something like reason="This mod is not compatible with <other mod> because both touch rendering internals in a non-compatible way."

shartte commented 6 months ago

Looks good in general. Three minor nitpicks:

* Please remove the "Replaced the `mandatory` field in NeoForge 20.4.40-beta". We assume people reading the docs to be on latest NeoForge.

* AFAICT the type value must be encased in "" (this is not the case in the example).

* Please add a simple example for the reason, something like `reason="This mod is not compatible with <other mod> because both touch rendering internals in a non-compatible way."`

Did 1) and 2), but will not do 3) since I'll leave that up to further improvement ;)