docs: reframe the What If page around the web UI, and refresh the intro pages - #4389
Merged
Conversation
The page opened with the methodology and then 110 lines of YAML, and did not mention the WhatIf tab until line 174 - so the reader most likely to be on it, someone who will only ever use the web form, had to wade through a config file reference aimed at the minority who script it. The first line even called the whole thing "a standalone command line tool". Reordered, not rewritten: the sections themselves are almost entirely unchanged, since the caveats in them are carefully worded. What moved is the order, and what changed is the connective tissue around the seams. Now: what it answers, then using the WhatIf tab, then what the numbers mean, then how it works, then limitations - with running it from the command line and the configuration file as clearly-labelled Advanced sections at the end, and debugging after those. Verified no content was lost in the move with a sorted-line diff, and that all five internal anchors still resolve. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the What If Annual Prediction documentation so that web-UI users hit the WhatIf tab workflow first, with CLI/config-file details moved into clearly-marked “Advanced” sections later in the page.
Changes:
- Replaced the intro to focus on the “What would solar and a battery actually save me?” question and immediately route users to the WhatIf tab.
- Reordered major sections so that web UI usage and result interpretation come before methodology, limitations, and advanced CLI/config reference.
- Adjusted cross-references so internal links point to the new “Advanced” headings.
It sat under "Viewing Predbat data" beside output-data, web-interface and compare - all pages about inspecting a Predbat that is already running against your hardware. What If is a different thing: a standalone projection you can run before owning any of it, which is exactly the reader the page now opens for. Its own top-level section, immediately after the viewing pages. The file name is unchanged, so no existing link or bookmark breaks - it is referenced only from the nav. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The intro pages were accurate but had fallen behind. Nothing in them was wrong; several things were simply missing. index.md listed the supported inverters explicitly but omitted Deye and Enphase, both registered components with documented apps.yaml settings - an explicit list that leaves something out reads as "not supported". Both are cloud-only, so they say so. what-does-predbat-do.md said energy pricing came from "the Octopus Energy integration", which has not been the whole story for a while: Kraken covers EDF and E.ON Next, Energidataservice and Strømligning cover Denmark, spot-rate sensors cover elsewhere, and Axle VPP events are handled too. It also described load prediction as coming from history alone, with no mention of the neural network that now learns time-of-day and day-of-week patterns alongside it, and listed neither Compare nor What If among the features. What If is called out on the index page as well, under its own heading: it is the one part of Predbat that needs no hardware and no configuration, so it is what a reader who has not bought anything yet can actually use today. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
springfall2008
changed the title
springfall2008
added
the
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The What If Annual Prediction page opened with the methodology and then 110 lines of YAML config reference, and did not mention the WhatIf tab until line 174. The reader most likely to be on that page — someone who will only ever use the web form — had to wade through a config file aimed at the minority who script it. The opening line even described the whole thing as "a standalone command line tool".
What changed
Reordered, not rewritten. The sections themselves are almost entirely untouched — the caveats in them are carefully worded and worth keeping exactly as they are. What moved is the order; what I rewrote is the connective tissue at the seams.
The new order:
Both Advanced sections now say plainly who they are for, so a web-only reader knows they can stop at Limitations.
Checks
Docs-only: one commit, one file.
🤖 Generated with Claude Code