Skip to content

[Docs] Update README, architecture diagrams, website, and keynote slides#162

Merged
samzong merged 1 commit intomainfrom
docs/readme-architecture-keynote-update
Mar 24, 2026
Merged

[Docs] Update README, architecture diagrams, website, and keynote slides#162
samzong merged 1 commit intomainfrom
docs/readme-architecture-keynote-update

Conversation

@samzong
Copy link
Copy Markdown
Collaborator

@samzong samzong commented Mar 24, 2026

Summary

Comprehensive documentation refresh: rewrite README with product-focused language and new features, add architecture SVG diagrams (dark + light), integrate architecture section into the website, and update keynote slides with new content and layout fixes.

Type of change

  • [Docs] documentation-only change

Why is this needed?

README was outdated — missing cron scheduling, notifications, agent management, auto-extract, auto-update, and other shipped features. Architecture was shown as ASCII art. Website had no architecture section. Keynote slides had image overflow issues and outdated version references.

What changed?

  • README.md: Rewritten with product-focused language, updated features list, new "What it stores" / "Repo layout" / "Tech stack" / "Platform notes" sections, updated roadmap (v0.0.10), architecture SVG replacing ASCII diagram
  • docs/architecture.svg + docs/architecture-light.svg: New product-showcase SVG diagrams with three-panel app wireframe, multi-gateway visualization, vector logo, dark and light variants
  • website/src/components/Architecture.tsx: New Architecture section between Features and QuickStart
  • website/src/components/Header.tsx: Added "Architecture" nav link
  • website/src/i18n/en.ts + zh.ts: Added architecture translations and nav key
  • website/src/App.tsx: Integrated Architecture component
  • website/public/: Copied both SVG variants
  • keynote/slides.md: Updated architecture slide (left-right layout), added About Me slide, updated Current Status to v0.0.10, added GitHub card CTA, replaced release history, fixed image overflow on all screenshot slides
  • keynote/public/images/architecture.svg: Copied dark SVG
  • package.json: Added pnpm dev:website script

Architecture impact

  • Owning layer: shared (none) / main (none) / preload (none) / renderer (none)
  • Cross-layer impact: none — documentation and website only
  • Invariants touched from docs/architecture-invariants.md: none
  • Why those invariants remain protected: no code changes to desktop app

Linked issues

N/A

Validation

  • pnpm lint
  • pnpm test
  • pnpm build
  • Manual smoke test
  • Not run

Commands, screenshots, or notes:

Lint and architecture check passed via pre-commit hook.
Website typecheck passed: pnpm --filter @clawwork/website exec tsc --noEmit

Screenshots or recordings

Architecture diagram (dark):
architecture

Release note

  • No user-facing change. Release note is NONE.
NONE

Checklist

  • The PR title uses at least one approved prefix: [Docs]
  • The summary explains both what changed and why
  • Validation reflects the commands actually run for this PR
  • Architecture impact is described and references any touched invariants
  • Cross-layer changes are explicitly justified
  • The release note block is accurate

- Rewrite README with product-focused language, new features (cron, notifications, agent mgmt, auto-extract), updated roadmap, and architecture SVG
- Add dark and light architecture SVG diagrams with vector logo, multi-gateway visualization
- Website: add Architecture section with i18n, nav link, and SVG embed
- Keynote: update architecture slide to left-right layout, add About Me slide, update release history to v0.0.10, add GitHub card CTA, fix image overflow across all slides
- Add pnpm dev:website script
@github-actions
Copy link
Copy Markdown
Contributor

Hi @samzong,
Thanks for your pull request!
If the PR is ready, use the /auto-cc command to assign Reviewer to Review.
We will review it shortly.

Details

Instructions for interacting with me using comments are available here.
If you have questions or suggestions related to my behavior, please file an issue against the gh-ci-bot repository.

@samzong samzong merged commit eabc25d into main Mar 24, 2026
8 checks passed
@samzong samzong deleted the docs/readme-architecture-keynote-update branch March 25, 2026 02:05
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