batpred icon indicating copy to clipboard operation
batpred copied to clipboard

Tracking changes and Predbat enhancements better

Open gcoan opened this issue 1 year ago • 0 comments

Is your feature request related to a problem? Please describe. Predbat is a great tool with lots of people using it, but at the moment the current ways of working make it difficult for users to understand what's changed. The release notes are not always comprehensive and its especially a problem for those that don't upgrade automatically to every release.

Describe the solution you'd like We've put a lot of effort in to improving the structure and content of the predbat documentation, to bring more logical flow to understanding related settings and controls. We don't want to lose this.

I propose we introduce a new page to the documentation 'update history' or somesuch name, and for every new feature/apps.yaml entry/new control/input entity etc we add a brief 1 line description of what it is, and then a link to the appropriate detailed entry in the main predbat documentation. This then gives a central jumping off place of changes to the main documentation and doesn't duplicate the documentation. It also gives something for the github release notes to link to.

Describe alternatives you've considered It may be possible to do this with directly with github release notes but I think something that's within the main predbat documentation would be more integrated and easier for others to find and read through.

Welcome to other ideas of best practice though

gcoan avatar Mar 30 '24 10:03 gcoan