Skip to content

docs: showcase-ready README, license, persona doc, visual assets#32

Merged
Lelevinson merged 1 commit into
mainfrom
feat/showcase-docs
Jun 10, 2026
Merged

docs: showcase-ready README, license, persona doc, visual assets#32
Lelevinson merged 1 commit into
mainfrom
feat/showcase-docs

Conversation

@Lelevinson

Copy link
Copy Markdown
Owner

What

Turns the repo into a shareable, portfolio-grade project:

  • Root README rewritten as the public face — hero logo + badges, a 4-shot demo gallery (storefront / admin / routines / product detail, captured live via Puppeteer), a real WhatsApp transcript of the routine concierge, mermaid diagrams (preview→confirm→audit sequence + architecture), the safety model front and center, the two-layer eval story, condensed quickstart, repo map, stack, and an honest-limitations section.
  • LICENSE — MIT.
  • docs/persona.md — canonical, reproducible copy of the machine-local agent voice (SOUL.md / IDENTITY.md), including the "warmth must not soften the rails" lesson.
  • setup.md §2 — host prerequisites moved here from the old README (nothing lost).
  • docs/README.md — index updated (assets/, persona.md, both roadmaps).
  • docs/assets/ — slimmed logo (1.5MB → 132KB) + 4 screenshots, dev-mode badge hidden, resized for fast loads.

Verification

  • Both mermaid diagrams validated with mermaid-cli (render OK).
  • Every README link target checked to exist.
  • Docs-only change; no code paths touched.

🤖 Generated with Claude Code

Rewrites the root README as the project's public face: hero logo + badges,
a four-shot demo gallery (storefront, admin, routines, product detail), a
real WhatsApp transcript of the routine concierge, mermaid diagrams for the
preview→confirm→audit consent gate and the overall architecture, the
safety model as the centerpiece, the two-layer eval story, a condensed
quickstart, and an honest-limitations section.

Supporting docs: MIT LICENSE; docs/persona.md as the canonical, reproducible
copy of the machine-local agent voice (SOUL.md/IDENTITY.md); host
prerequisites preserved in setup.md §2 (moved from the old README);
docs/README.md index updated for assets/ + persona.md + both roadmaps.

Assets generated from the live app via Puppeteer (dev badge hidden,
resized); logo trimmed from web/public/deskclaw.png to 420px.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@Lelevinson Lelevinson merged commit 98e89ea into main Jun 10, 2026
2 checks passed
@Lelevinson Lelevinson deleted the feat/showcase-docs branch June 10, 2026 12:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant