docs: reconcile number-entity count to five (add ramp_half_width) (#1)

The README What's-new callout and the CHANGELOG 2.1.0 entry still said four number entities, while the README table/intro and the runtime-range-controls spec say five (the four range bounds plus ramp_half_width). Update the callout to list all five and add a CHANGELOG entry for the fifth entity; leave the historical 2.1.0 'four' entry intact. Docs only -- code and spec already reflect five. Filed as openspec change fix-number-entity-count-docs.
This commit is contained in:
Casey Romkes 2026-07-08 23:02:22 +02:00 committed by GitHub
commit f4ec31ecc8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 48 additions and 1 deletions

View file

@ -0,0 +1,2 @@
schema: spec-driven
created: 2026-07-08

View file

@ -0,0 +1,3 @@
# fix-number-entity-count-docs
Reconcile CHANGELOG and README to five number entities (adds ramp_half_width)

View file

@ -0,0 +1,24 @@
## Why
The count of `number` entities per profile is inconsistent across the Adaptive Lighting docs. The integration exposes **five** live-tunable `number` entities per profile — the four range bounds (`min_brightness`, `max_brightness`, `min_color_temp`, `max_color_temp`) plus `ramp_half_width` — as stated in the README reference table ("Number entities (5)") and intro ("five live-tunable sliders"), and as required by the `runtime-range-controls` spec ("exposes five runtime curve entities"). But two doc locations still say four: the README's top callout block ("four live-tunable sliders", listing only the four range entities) and the `CHANGELOG.md` `2.1.0-cdit.1` "Added" entry, which introduced the original four and was never followed by an entry recording the fifth (`ramp_half_width`). A reader gets contradictory counts inside the same README.
## What Changes
- **README**: update the top callout block (the "four live-tunable sliders" section) to list all five entities, adding `number.<profile>_ramp_half_width`, so it matches the reference table and intro further down the same file.
- **CHANGELOG**: add an entry under the appropriate unreleased version documenting the `ramp_half_width` number entity as the fifth live-tunable slider. Leave the historical `2.1.0-cdit.1` "four" entry intact — it accurately records the release that introduced the first four; the gap is the missing later entry, not a wrong historical one.
- No source change: the implementation already creates five entities.
- No spec change: `runtime-range-controls` already specifies five (its "four range entities" wording refers to the range subset, distinct from the ramp control).
## Capabilities
### New Capabilities
None. Documentation-only correction.
### Modified Capabilities
None. `runtime-range-controls` already reflects five entities; behavior is unchanged.
## Impact
- `Adaptive_lighting/README.md` (top callout block) and `Adaptive_lighting/CHANGELOG.md` (one added entry). No source or spec files change.

View file

@ -0,0 +1,9 @@
# Tasks
## 1. Reconcile the number-entity count across the docs
- [x] 1.1 In `README.md`, update the top callout block that says "four live-tunable sliders" to list all five entities, adding `number.<profile>_ramp_half_width`
- [x] 1.2 In `CHANGELOG.md`, add an entry under the current unreleased version documenting the `ramp_half_width` number entity as the fifth live-tunable slider; leave the historical `2.1.0-cdit.1` "four" entry unchanged
- [x] 1.3 Verify the README intro ("five live-tunable sliders") and the reference table ("Number entities (5)") now agree with the corrected callout
- [x] 1.4 Grep the repo for other stale "four ... number"/"four ... slider" doc references and fix any stragglers
- [x] 1.5 Leave source and the `runtime-range-controls` spec untouched (both already reflect five entities)