98 lines
No EOL
4.6 KiB
Markdown
98 lines
No EOL
4.6 KiB
Markdown
# OpenCD v1.0.0 — Release Notes
|
||
|
||
> *"I love it when a plan comes together."* — Col. John "Hannibal" Smith
|
||
|
||
**Release date:** 2026-05-25
|
||
**Commit:** Latest on `main` (GPG-signed: `D1ADA6EC42B96E5BDAE95B5B48DF9E0094796329`)
|
||
**Framework:** OpenCD — Physical CD jewel case HTML/CSS framework
|
||
**Built on:** [Open Props](https://open-props.style) v2
|
||
|
||
---
|
||
|
||
## Team Credits
|
||
|
||
| Role | Profile | Key | Area |
|
||
|------|---------|-----|------|
|
||
| **Commander** | Hannibal Smith | `48DF9E0094796329` | Final synthesis, release, signed final commit |
|
||
| **Recon** | Face | `696A18EFB764ADE` | RECON.md — Open Props audit, CD specs, ASW/trentuna study |
|
||
| **Gate** | Amy Allen | `C103A95E28714F6C` | MISSION_BRIEF.md — quality criteria, findings, gate review |
|
||
| **Prototype** | Murdock | `ABE295FFEB4571F8` | opencd.css + 3 HTML templates (jewel-case, leaflet, back-tray) |
|
||
| **Production** | B.A. Baracus | `1D05905DE3C03A27` | Hardened opencd.css — zero magic numbers, Nous auth, ASW semantics |
|
||
| **Validation** | Amy Allen | `C103A95E28714F6C` | VALIDATION.md — 12 PASS, 1 CONCERNS, 0 FAIL |
|
||
| **Architect** | Hannibal Smith | `48DF9E0094796329` | DESIGN.md — framework architecture planning |
|
||
|
||
All commits are GPG-signed with individual team member keys.
|
||
|
||
---
|
||
|
||
## Deliverables
|
||
|
||
### Core Framework
|
||
- **`opencd.css`** (711 lines) — CD jewel case CSS framework
|
||
- ISO 15727 physical CD dimensions at 2× scale
|
||
- 60+ `--cd-*` custom properties (zero Open Props token leakage)
|
||
- ASW-style semantic surface layers in `oklch` colorspace
|
||
- 7-component architecture: jewel case, spine, leaflet, disc art, advisory badge, back tray, grid overlay
|
||
- Open/close state via BEM modifier + `data-jewel-state` attribute
|
||
- Container query responsive design
|
||
- Print styles with physical `mm` units
|
||
- Grain texture utility classes
|
||
- **Zero magic numbers** — every value is a `--cd-*` custom property
|
||
|
||
### Templates
|
||
- **`templates/jewel-case.html`** — CD jewel case wrapper with open/close + scale demo controls
|
||
- **`templates/leaflet.html`** — 4-page booklet with page-turn navigation
|
||
- **`templates/back-tray.html`** — Dual spines, tracklist, credits, grid toggle
|
||
|
||
### Documentation
|
||
- **`README.md`** — Project overview, quick start, philosophy
|
||
- **`DESIGN.md`** — Architecture plan: 9 CSS modules, Open Props token mapping, responsibility matrix
|
||
- **`RECON.md`** — Reconnaissance: Open Props audit, CD specification analysis, ASW/trentuna study
|
||
- **`MISSION_BRIEF.md`** — Quality criteria, 4 findings, and gate review with CONCERNS verdict for initial prototype
|
||
- **`VALIDATION.md`** — 12 PASS / 1 CONCERNS / 0 FAIL validation of production build (follow-up fixed)
|
||
- **`RELEASE_NOTES.md`** — This file
|
||
|
||
### Infrastructure
|
||
- **`.env.example`** — Nous auth configuration schema
|
||
- **`.gitignore`** — Standard ignores (`.env`, editor files, build artifacts)
|
||
|
||
---
|
||
|
||
## Quality Summary
|
||
|
||
The production build passed validation with 12/12 PASS criteria, 0 FAIL. A single CONCERNS — three inline values violating the zero-magic-numbers principle — was addressed in this release (final synthesis pass). The three values (`font-weight: 600`, `opacity: 0.8`, `z-index: 1`) now use proper `--cd-*` custom properties: `--cd-font-weight-semibold`, `--cd-text-opacity-muted`, `--cd-z-stack-base`.
|
||
|
||
---
|
||
|
||
## Architecture Highlights
|
||
|
||
- **Physical-dimension-driven design** — every layout value traces back to real CD packaging measurements (ISO 15727)
|
||
- **Custom property cascade** — `:root` defines dimension, color, typography, spacing, and motion tokens; components reference `--cd-*` only
|
||
- **ASW-style colors** — Surface layers use custom `oklch` values instead of Open Props defaults, giving the framework a distinct visual identity
|
||
- **Open Props integration** — Safely uses Open Props for internal values (font sizes, spacing ratios, shadows, easings) while exposing a clean `--cd-*` public API
|
||
- **Responsive architecture** — Container queries at 350px/550px breakpoints; print styles auto-switch to physical `mm` units
|
||
- **No JavaScript required** — Template interactions (open/close, page turns) use native HTML/CSS with minimal inline JS for demo controls
|
||
|
||
---
|
||
|
||
## Getting Started
|
||
|
||
```html
|
||
<!-- Include in your project -->
|
||
<link rel="stylesheet" href="https://unpkg.com/open-props">
|
||
<link rel="stylesheet" href="opencd.css">
|
||
|
||
<!-- Use a template -->
|
||
<h1>Your CD Project</h1>
|
||
<article class="cd-jewel" data-jewel-state="open">
|
||
<!-- ... -->
|
||
</article>
|
||
```
|
||
|
||
See `templates/jewel-case.html` for a complete working example.
|
||
|
||
---
|
||
|
||
**License:** MIT
|
||
**Built with:** Open Props v2+
|
||
**Nous deployment:** Portal URL and API key schema in `.env.example` |