DuDuClaw OS Documentation

This content is not available in your language yet.

Public documentation index for DuDuClaw OS (v0.1.0, bring-up). Every document in this repo is filed by the same TYPE × CONFIDENTIALITY rule as the DuDuClaw platform repo — see ../CLAUDE.md → “Documentation Classification & Placement”.

Start here

Document	Description
../README.md · ../README.en.md	What DuDuClaw OS is, the two release artifact forms, verify / flash quick start, build pipeline
../CHANGELOG.md	Release history (Keep a Changelog 1.1.0; the OS version line is independent of the platform)
../CONTRIBUTING.md	Where changes go, definition of done, docs-in-the-same-commit rule
../SECURITY.md	Vulnerability reporting, scope, release-artifact verification

Component references (L1, co-located)

Document	Description	Status
../meta-duduclaw/README.md	The Yocto layer: target release, layout, image recipes and their roles, builder container, `kas build`, QEMU boot, machine-aliasing gotchas	Current
../appliance/README.md	The earlier Debian/mkosi appliance line: layout, boot sequence, A/B wiring, Flatpak layer, open points	Frozen (reference only)
../appliance/tests/README.md	VM acceptance-test helper library (QMP screendump, serial expect-login, OCR screen assertions)	Frozen with the line
../docs-site/README.md	The documentation site (Astro + Starlight) that publishes this tree and the platform repo’s public docs at `/docs/`: how to run it, the public whitelist, the three-locale layout, and the sync script	Current
`../deploy/cloudrun/` + `../scripts/deploy-cloudrun.sh`	Cloud Run container for the public site (nginx, CSP/cache headers, extra MIME types) and the build-and-deploy script; one-time domain mapping notes live in `../website/README.md`	Current

Recipe-level behaviour is documented in each .bb / .bbclass header comment; those comments are the reference for that recipe and are not duplicated here.

Public docs by type (`docs/<type>/`)

Document	Description
guides/ai-runtimes.md	The bundled AI coding CLIs and llama.cpp: what is installed, what is deliberately not, where credentials live, how to run a local model, how to regenerate the runtime bundle, and the root-slot budget it consumes
guides/platform-sync.md	Bringing the OS layer to one platform release with `scripts/sync-platform.sh`: the four snapshot refreshes, the embedded platform version bump + recipe renames, the fail-closed guards (stale detached lockfile, clobbered dependency version, stale dashboard dist), and what to bake and verify afterwards

The remaining subdirectories are created when their first document lands:

Subdir	Holds
`architecture/`	boot chain, partition layout, update chain, trust chain
`guides/`	how-tos: building, flashing, real-hardware install, key management
`features/`	feature deep-dives from the user’s side
`spec/`	open formats: release manifest schema, update payload layout
`adr/` · `rfc/` · `todo/`	decisions, proposals, public tracking

User-facing OS docs currently published from the platform repo:

Document	Description
DuDuClaw OS appliance	What the finished box does, from the user’s side
OS keyboard shortcuts	Global compositor bindings, shell UI, first-run setup, lock screen
Hardware requirements & compatibility	x86-64-v3 / UEFI / SSD hard requirements, recommended mini-PCs, driver gaps
App compatibility layer	`compat.d` runners, Bottles, Waydroid, what is and is not promised
Building the mkosi appliance image	Describes the `appliance/` line, which is now frozen here

Internal notes (L2, `wiki/`)

Document	Description
../wiki/impl/meta-duduclaw-bring-up-notes-2026-08.md	Archived layer README from the Y1–Y9 bring-up waves: why three repos / why kas, UKI chain verification, disk strategy, fcitx5 dependency closure, `/data` provisioning. Dated; superseded by the CHANGELOG and the current layer README
../wiki/eval/real-hw-acceptance-checklist-y6-3-2026-08-26.md	Real-hardware acceptance checklist written for the Y6 burn package (N305 / 8845HS). Its premises predate v0.1.0
../wiki/reports/bring-up-evidence/	QEMU boot and bitbake transcripts behind the bring-up “verified” claims
../wiki/eval/desktop-iso-qemu-walkthrough-2026-09-05.md	Desktop-edition installer ISO walked end to end under QEMU on a Mac host (installer → first boot → lock screen); PASS table, defects found, demo video provenance
../wiki/eval/ai-runtimes-qemu-walkthrough-2026-09-06.md	AI-runtime bundle / local model / fine-tuning round walked under QEMU: bundled CLI versions, OOBE provider list + risk notice + real `claude setup-token` URL, `runtime.detect`, GGUF download → llama-server, dry-run fine-tune job, defects found and fixed (/lib64 loader, `linux-container`, `openai_compat` wire name)
../wiki/eval/fix14-launcher-footer-qemu-2026-09-08.md	fix14 → v1.63.0 platform sync: shell snapshot (Launcher footer「⌘K 隨時喚起」), then all four platform snapshots + `duduclaw-platform-version.inc` moved to v1.63.0, baked and verified under QEMU (os-release, `duduclaw --version`, A/B UKI `duduclaw-os_1.63.0-y1-bringup.efi`); the bake log — stale detached Cargo.lock and a dependency-clobbering bump in the platform’s release.sh, cargo ignoring PARALLEL_MAKE (OOM), 89 GB build-volume exhaustion — and what each taught

Directory structure

docs/                        # L1 PUBLIC — typed product & developer docs
├── README.md                # This index
├── architecture/            # (created with its first document)
├── guides/
├── features/
├── spec/
└── adr/  rfc/  todo/
wiki/                        # L2 INTERNAL — bring-up notes, checklists, evidence
├── impl/
├── eval/
└── reports/<kind>/
commercial/  research/       # L3 CONFIDENTIAL — reserved, gitignored, never committed

Confidentiality tiers — docs/ and the root docs are Public. wiki/ is Internal (committed, unpolished). Design docs, roadmaps, commercial/competitive notes, research, and signing keys are Confidential and never enter this repo; the OS design docs live in the platform maintainers’ private tree. Full rule: ../CLAUDE.md.