search

neoforged / Documentation

The repository containing Neo's documentation
MIT License
23 stars 36 forks source link

Configuration system #127

Open HenryLoenwind opened 2 days ago

HenryLoenwind commented 2 days ago

I started a rewrite on the configuration system to include the new UI (PR pending), and to make the article more accessible.

Comments welcome.

PS: Is the method using configure still important? It looks overly complicated with no real value to me, so I'm tempted to drop it from the documentation.

HenryLoenwind commented 1 day ago

My general comments is that everything is shallowly explained.

Yes, I only made the new introduction sections so far and haven't touched the detailed sections below. The introduction can be thinned out of details once I got the other sections, but I at least want to touch the important data points up-front to. That way someone who only reads the overview has enough of an idea to work with the system and do "the 90%" when they start with the MDK.

"the 90%": 90% of the mods and 90% of the config settings of the other 10% will have the form of a couple of bools and ints with maybe one or two sections for organisation. In my opinion, everything you need to do this correctly should be a 5-minute read and the MDK as a starting point. The rest of the documentation page should then cover all the "Can I do X?" and "How do I do Y?" questions but not be a requirement for the typical "feature_A_enabled = false" configs.

Note that I have mostly answered questions and explained why I did certain things, but I have not commented which suggestions I will incorporate. So don't take a lack of that as rejection.