Website site plan
Plan for Cabin’s public documentation site — a Material Design 3–class showcase for the automobile cabin (m3.material.io as IA reference, not a visual clone).
Phase 7 deliverable (roadmap). This document freezes information architecture so docs and future implementation stay aligned.
Goals
- Help OEMs, Tier-1s, and app developers learn Cabin quickly.
- Showcase foundations, components, and patterns with dual-stack callouts.
- Version docs with library releases.
- Host an interactive catalog entry point.
Primary navigation (IA)
Modeled on Material’s discoverability, adapted for automotive:
| Top-level | Purpose |
|---|---|
| Home | Pitch, dual-stack, compliance story, get started |
| Foundations | Color, type, space, elevation, motion, iconography |
| Styles | Token themes, day/night, OEM overlay guide |
| Components | Chrome + domain component gallery |
| Patterns | Driving-safe browse, fault recovery, zone climate, charge session |
| Compliance | Driving, UX, a11y/glance, safety-critical |
| Develop | Compose, Views, adoption, packaging |
| Blog / Versions | Release notes, migration notes, roadmap highlights |
Mapping to repo docs
| Site section | Repo docs |
|---|---|
| Home | vision, root README |
| Foundations | foundations |
| Styles | tokens |
| Components | components/* |
| Patterns | Derived from compliance + component flows |
| Compliance | compliance/* |
| Develop | platforms, adoption |
| Blog / Versions | roadmap, release notes (future) |
Page templates
Foundation page
- Principle summary
- Do / don’t
- Token references
- Day/night examples
- Compose + Views usage snippets (planned APIs labeled)
Component page
- Overview + placement in cabin
- Anatomy
- States
- Compliance behavior
- Dual-stack demos (Compose live; Views video/screenshot if needed)
- API tabs: Compose | Views
- Accessibility notes
Pattern page
- When to use
- Driving vs Park behavior
- Composition of components
- Failure modes
Catalog
- Thin sample APK under
catalog/demos Theme Kit day/night, Views + Compose System/Status bars, Restriction Engine modes, and signal / tone states (no domain screens). Linked from Components later. - Filters (later): stack, domain, safety class, compliance relevance.
- Deep links from site component pages to catalog destinations (later).
Content principles
- Authoritative, specific — same tone as these docs.
- Always call out Compose + Views and compliance where relevant.
- Mark unimplemented demos clearly during early phases.
- American English.
Technical preferences
Stack (chosen for the early docs shell): Docusaurus in top-level
website/, fully decoupled from Android library modules. See
website/README.md
for install / start / build / deploy.
Marketing site (separate): User-facing product marketing lives in
apps/www (Next.js). It does not replace
website/ — docs remain the developer reference on GitHub Pages; marketing
deep-links to that docs host. Marketing visual and copy craft is governed by
apps/www/DESIGN.md (anti-vibecode brief); see also
marketing-craft.md.
Planned capabilities as the site matures:
- Versioned routes (
/1.0/…) - Search
- Dark/light matching Cabin day/night where helpful
- Fast CI publish from
website/+docs/
Maintainer override: thin public docs shell may ship before the original Phase 7 / catalog milestone. Full interactive catalog remains later.
Launch milestones
- IA + content migration from
docs/(structure already matches). - Foundations + Compliance live (no interactive catalog yet).
- Components with static visuals.
- Catalog integration.
- Version switcher + blog.
Out of scope for v1 site
- Full OEM white-label docs hosting
- Private program portals
- Live vehicle signal demos