[GH-ISSUE #1461] Explain practical function of config settings #1256

Open
opened 2026-02-26 00:34:47 +03:00 by kerem · 0 comments
Owner

Originally created by @SirYavin on GitHub (Feb 11, 2026).
Original GitHub issue: https://github.com/hirschmann/nbfc/issues/1461

The current documentation as to creating or modifying a config for a notebook not included in the pre-installed list of configs is unclear and not elaborated upon. Trial-and-error should never be required for something controlling a notebook's physical hardware--nor should uncertainty.

Please elaborate as to the actual function and practical result of each of the various config settings in a plain-word context in the config guide, rather than exclusively describing each config setting as a mathematical equation dependent on other config settings that are themselves described only as mathematical equations.

Normally I'd try to elaborate as to the specific settings that are dubiously described or unclear--but in this case, I'd be listing every single setting, because none of them correspond to actual measurements; they all appear to be assigned to arbitrary ranges, and don't appear to even be locked to those ranges (such as insisting my current fan speed is 142%). There is no relevant documentation for instances like this, and the guide--in it's current form--offers no guidance as to which setting would affect or correct this.

I cannot stress enough that a program of this nature is explicitly unsafe to use without knowing what it is doing, and what you are telling it to do as a user. Therefore, it is critical that the documentation instructing users on proper usage of this program be reasonably understandable to even the average user. Unfortunately, it is not.

Originally created by @SirYavin on GitHub (Feb 11, 2026). Original GitHub issue: https://github.com/hirschmann/nbfc/issues/1461 The current documentation as to creating or modifying a config for a notebook not included in the pre-installed list of configs is unclear and not elaborated upon. Trial-and-error should never be required for something controlling a notebook's physical hardware--nor should uncertainty. Please elaborate as to the actual function and practical result of each of the various config settings in a plain-word context in the config guide, rather than exclusively describing each config setting as a mathematical equation dependent on other config settings that are themselves described only as mathematical equations. Normally I'd try to elaborate as to the specific settings that are dubiously described or unclear--but in this case, I'd be listing every single setting, because none of them correspond to actual measurements; they all appear to be assigned to arbitrary ranges, and don't appear to even be locked to those ranges (such as insisting my current fan speed is 142%). There is no relevant documentation for instances like this, and the guide--in it's current form--offers no guidance as to which setting would affect or correct this. I cannot stress enough that a program of this nature is explicitly unsafe to use without knowing what it is doing, and what you are telling it to do as a user. Therefore, it is critical that the documentation instructing users on proper usage of this program be reasonably understandable to even the average user. Unfortunately, it is not.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/nbfc-hirschmann#1256
No description provided.