docs(okf): add Nuxt knowledge bundle in OKF v0.2
Record the design decisions behind the Nuxt site as an OKF v0.2 bundle: dev container shape, build layer order, build context filter, repository and compose layout, and the mockup layout, plus the open questions. Conformant per the spec: every concept carries a non-empty type, the reserved index and log files follow their structures, and every internal link resolves.
This commit is contained in:
1 parent
5caa3457aa
commit
8fa078707c
9 files changed
+390
No files matched your search
@@ -0,0 +1,55 @@
|
||||
---
|
||||
type: Decision
|
||||
title: Mockup layout
|
||||
description: Every mockup screen folder holds DESIGN.md, code.html and screen.png, with the screenshot and the full source embedded in the markdown.
|
||||
tags: [decision, design, mockups]
|
||||
status: stable
|
||||
generated: { by: opencode/deepseek-v4.1-flash, at: 2026-10-18T12:41:52Z }
|
||||
verified: { by: human:noel, at: 2026-10-18T12:41:52Z }
|
||||
sources:
|
||||
- id: stitch-export
|
||||
resource: Stitch export "resilient_systems_engineer_portfolio", seven screens
|
||||
title: Stitch export used for the mockups
|
||||
---
|
||||
|
||||
# Decision
|
||||
|
||||
Each screen is one folder holding three files, all at the same level:
|
||||
|
||||
| File | Role |
|
||||
|---|---|
|
||||
| `DESIGN.md` | The screen as a document: frontmatter, the screenshot rendered inline, then the full source in a fenced block. |
|
||||
| `code.html` | The screen's source, unchanged. |
|
||||
| `screen.png` | The rendered screenshot, kept separately so it can be opened directly. |
|
||||
|
||||
The export's folder names were replaced with short, consistent ones:
|
||||
|
||||
| Export name | Folder |
|
||||
|---|---|
|
||||
| `noel_sabia_homepage_cv_overview` | `homepage` |
|
||||
| `noel_sabia_overview_mobile` | `homepage_mobile` |
|
||||
| `noel_sabia_dev_view_technical_telemetry` | `dev_view` |
|
||||
| `noel_sabia_dev_view_mobile` | `dev_view_mobile` |
|
||||
| `noel_sabia_life_map` | `life_map` |
|
||||
| `noel_sabia_life_map_mobile` | `life_map_mobile` |
|
||||
| `noel_sabia_infrastructure_ai_resilience` | `design_system` |
|
||||
|
||||
# Why
|
||||
|
||||
A screen should be readable as one document without opening anything else, which
|
||||
is what embedding the screenshot and the source gives. Keeping `screen.png` beside
|
||||
the markdown as well is for looking at the picture on its own, without reading the
|
||||
document around it.
|
||||
|
||||
The frontmatter on `DESIGN.md` — `type`, `title`, `description`, `tags`,
|
||||
`status` — is also valid concept frontmatter, so these files are readable as
|
||||
concepts if the mockups are ever folded into a knowledge bundle.
|
||||
|
||||
# Notes
|
||||
|
||||
* The export shipped `DESIGN.md` and nothing else for the infrastructure folder.
|
||||
That folder is the design-token document, not a screen, so it deliberately has
|
||||
no `code.html` and no `screen.png`.
|
||||
* A second, byte-identical copy of the export was deleted. Equality was checked
|
||||
file by file with `cmp` across all 13 files before anything was removed.
|
||||
* Committed as `docs(design): embed screenshot and source into per-screen DESIGN.md`.
|
||||
Reference in new issue
Block a user