ini/configuration guide missing a lot of options

[john-parton]

The configuration guide here: https://github.com/diasurgical/devilutionX/wiki/DevilutionX-diablo.ini-configuration-guide

Is missing a ton of options present in https://github.com/diasurgical/devilutionX/blob/1409e604f56698f7ea0c21b3820d20d4c6b1dba7/Source/options.cpp

I see "Show health values" and "Show mana values" here:

devilutionX/Source/options.cpp

Lines 760 to 761 in 1409e60

	, showHealthValues("Show health values", OptionEntryFlags::None, N_("Show health values"), N_("Displays current / max health value on health globe."), false)
	, showManaValues("Show mana values", OptionEntryFlags::None, N_("Show mana values"), N_("Displays current / max mana value on mana globe."), false)

As well as "Quick cast" and a bunch of options for automatically picking up potions:

devilutionX/Source/options.cpp

Lines 833 to 839 in 1409e60

	, quickCast("Quick Cast", OptionEntryFlags::None, N_("Quick Cast"), N_("Spell hotkeys instantly cast the spell, rather than switching the readied spell."), false)
	, numHealPotionPickup("Heal Potion Pickup", OptionEntryFlags::None, N_("Heal Potion Pickup"), N_("Number of Healing potions to pick up automatically."), 0, { 0, 1, 2, 4, 8, 16 })
	, numFullHealPotionPickup("Full Heal Potion Pickup", OptionEntryFlags::None, N_("Full Heal Potion Pickup"), N_("Number of Full Healing potions to pick up automatically."), 0, { 0, 1, 2, 4, 8, 16 })
	, numManaPotionPickup("Mana Potion Pickup", OptionEntryFlags::None, N_("Mana Potion Pickup"), N_("Number of Mana potions to pick up automatically."), 0, { 0, 1, 2, 4, 8, 16 })
	, numFullManaPotionPickup("Full Mana Potion Pickup", OptionEntryFlags::None, N_("Full Mana Potion Pickup"), N_("Number of Full Mana potions to pick up automatically."), 0, { 0, 1, 2, 4, 8, 16 })
	, numRejuPotionPickup("Rejuvenation Potion Pickup", OptionEntryFlags::None, N_("Rejuvenation Potion Pickup"), N_("Number of Rejuvenation potions to pick up automatically."), 0, { 0, 1, 2, 4, 8, 16 })
	, numFullRejuPotionPickup("Full Rejuvenation Potion Pickup", OptionEntryFlags::None, N_("Full Rejuvenation Potion Pickup"), N_("Number of Full Rejuvenation potions to pick up automatically."), 0, { 0, 1, 2, 4, 8, 16 })

Should these all be added?

[qndel]

Feel free to update it.

[StephenCWills]

These options were all added between 1.3 and 1.4, were they not? It might be okay to update now since we're coming up on the release of 1.4, but I personally think this wiki page should be kept accurate with the most recent release version.

[john-parton]

Fair. I personally can't time my edits.

Would it be okay to add "New in version 1.X" next to them or something? I feel like that would be helpful all around.

Django does something like that in their docs: https://docs.djangoproject.com/en/4.0/ref/models/querysets/#default

[StephenCWills]

Hmm... For 1.4 we are introducing a Settings menu complete with brief descriptions for individual settings. I suspect there will be little, if any, reason to maintain this wiki page going forward. Since I'm not sure about the purpose or target audience at that point, I'm also not sure I can provide any guidance on what would be okay. Personally, I'd just leave the page alone for now and try to figure it out after the release.

[john-parton]

OK, cool. I didn't know about the settings menu. I'll see if I can build master and poke around.

[AJenbo]

It's a wiki so mostly community maintained, so no reason to have an issue for this. I'll convert it to a discussion though as that fair.

[john-parton]

Thanks. Some projects consider documentation issues like this as bugs. I'll not open issues like this in the future.

[AJenbo]

We would for any of the docs house in the files, like the various readmes and https://github.com/diasurgical/devilutionX/tree/master/docs