|
1 | 1 | # PyBLE — Public Website Specification |
2 | 2 |
|
3 | 3 | Status: **FROZEN (pre-v1 and v1 launch surface)** · Owner: project maintainer · Last updated: |
4 | | -2026-07-30 |
| 4 | +2026-07-31 |
5 | 5 |
|
6 | 6 | This document is the source of truth for the first public website at |
7 | 7 | `pyble.dev`. It specifies only the public site; the Flutter app, PBLE/1, and |
@@ -102,6 +102,20 @@ it is an additional path, never the only way to open the invitation. A changed |
102 | 102 | or withdrawn invitation requires the specification, content contract, and QR |
103 | 103 | asset to change together before deployment. |
104 | 104 |
|
| 105 | +### 3.2 Public source repository |
| 106 | + |
| 107 | +The canonical public source repository is |
| 108 | +`https://github.com/PyBLE-dev/PyBLE`. The home page MUST identify the app, |
| 109 | +board-agent firmware, PBLE/1 protocol, tests, and documentation as public, |
| 110 | +MIT-licensed source and provide a prominent, accessible link to that exact |
| 111 | +repository. The global footer MUST provide the same repository link so it |
| 112 | +remains available from every launch route. |
| 113 | + |
| 114 | +Repository links MUST be ordinary HTTPS links and MUST NOT use a tracking |
| 115 | +redirect, embedded GitHub widget, remote badge, or client-side network request |
| 116 | +to present their primary information. If a link opens a new browsing context, |
| 117 | +it MUST use `noopener noreferrer`. |
| 118 | + |
105 | 119 | ## 4. Brand and visual contract |
106 | 120 |
|
107 | 121 | The canonical prompt-chip SVG in `app/assets/branding/` is the source asset. A |
@@ -333,6 +347,9 @@ The v1 site is releasable when: |
333 | 347 | pictured Blocks workspace or generated Python; |
334 | 348 | - the current external iPad beta invitation is exposed as an operable link and |
335 | 349 | a locally served, exact-URL QR code without claiming production availability; |
| 350 | +- the canonical public source repository is explained in a visible |
| 351 | + MIT-licensed-source section and linked from both that section and the global |
| 352 | + footer; |
336 | 353 | - lint, strict type checking, tests, static export, Sites vinext build, SPDX, and |
337 | 354 | no-leak gates pass; |
338 | 355 | - the Sites artifact contains `dist/server/index.js` and the exact project |
|
0 commit comments