Skip to content

Commit 5a434e8

Browse files
committed
[docs] Freeze pre-activation public claims
Signed-off-by: Viwat Vchirawongkwin <viwat.v@chula.ac.th>
1 parent 62e394e commit 5a434e8

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

‎docs/specifications/website.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,39 @@ platform cropping can make it unreliable. A separate local square TestFlight
132132
card MAY include the exact invitation QR, visible destination, and plain-text
133133
instructions.
134134

135+
### 3.4 Pre-activation release claims and support intake
136+
137+
Until the first v0.4.2 public firmware selector passes the complete gate in §7,
138+
the repository README and home page MUST say that the browser installer is
139+
unavailable pending v0.4.2 HIL on both exact current profiles. They MUST NOT
140+
describe either profile or its browser image as released, available, or
141+
qualified. The home-page target cards MUST identify the profiles and constraints
142+
as `esp32-4mb` (classic ESP32, 4 MiB external SPI flash, no PSRAM assumed) and
143+
`esp32-s3-n16r8` (ESP32-S3, 16 MiB flash, 8 MiB **Octal** PSRAM), and give each
144+
the truthful pending-HIL/unavailable state. `esp32-c3-4mb` remains a separate
145+
planned, unavailable profile.
146+
147+
README getting-started instructions MUST gate destructive flashing on `/flash`
148+
showing an active version, exact profile, and enabled install action. While the
149+
installer is unavailable, they MUST NOT instruct a reader to select or flash a
150+
supposedly qualified public image. A real-app capture caption MUST describe only
151+
what is visible; it MUST NOT claim that a physical board is pictured when the
152+
capture shows only the app.
153+
154+
While the installer is unavailable, the wide social card MUST describe the
155+
workflow as one-time USB setup followed by everyday use over BLE. It MUST NOT
156+
advertise an enabled web flasher; it MAY explicitly label firmware HIL as
157+
pending. Its mechanically rendered PNG and authored SVG MUST remain paired by
158+
reviewed content and exact-dimension tests.
159+
160+
The support route MUST link directly to the preferred GitHub bug template at
161+
`https://github.com/PyBLE-dev/PyBLE/issues/new?template=bug.yml`. Installer
162+
intake MUST request the exact profile ID, board/model and module marking, flash
163+
capacity, PSRAM capacity and type, browser name/version, desktop operating
164+
system/version, failed installer stage, and redacted error text. The issue
165+
template and support-page checklist MUST agree on those fields and remind users
166+
to remove secrets and personal identifiers.
167+
135168
## 4. Brand and visual contract
136169

137170
The canonical prompt-chip SVG in `app/assets/branding/` is the source asset. A

0 commit comments

Comments
 (0)