Skip to content

docs: add missing user guides for core framework systems#55

Merged
PAMulligan merged 14 commits intomainfrom
47-add-missing-user-guides-for-core-framework-systems
Apr 2, 2026
Merged

docs: add missing user guides for core framework systems#55
PAMulligan merged 14 commits intomainfrom
47-add-missing-user-guides-for-core-framework-systems

Conversation

@PAMulligan
Copy link
Copy Markdown
Collaborator

@PAMulligan PAMulligan commented Apr 2, 2026

Summary

  • Adds 11 user-facing documentation guides in docs/guides/ covering design tokens, visual QA, pipeline caching, hooks, error recovery, agent creation, and 5 framework-specific converter workflows (Vue, Svelte, React Native, Chrome Extension, PWA)
  • Creates docs/guides/README.md index organized by priority tier (P0/P1/P2)
  • Links new guides from onboarding documentation (quickstart.md and README.md)

Guides Added

P0 — Core Pipeline Systems

  • design-tokens.md — Token structure, lockfile format, validation, sync, drift detection
  • visual-qa.md — visual-diff.js internals, sub-pixel detection, typography analysis, threshold tuning
  • caching.md — Incremental builds, cache invalidation, profiling, metrics dashboard

P1 — Development Guides

  • hooks.md — Hook configuration, execution order, all 8 built-in hooks, custom hooks
  • error-recovery.md — Pipeline failure modes, resuming, manual phase execution
  • agent-creation.md — YAML frontmatter, tool declarations, model selection, best practices

P2 — Framework-Specific

  • vue-converter.md — Vue 3 Composition API, <script setup>, composables
  • svelte-converter.md — SvelteKit, Svelte 5 runes, stores
  • react-native-converter.md — Expo, NativeWind, native primitives
  • chrome-extension.md — Manifest v3, Playwright persistent context E2E
  • pwa.md — Service worker lifecycle, offline testing, Lighthouse PWA audit

Test plan

  • All files are Markdown documentation — no code changes
  • Verify all internal links resolve correctly
  • Verify guide content matches actual script behavior

Closes #47

🤖 Generated with Claude Code

Paul Mulligan and others added 6 commits April 2, 2026 15:13
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan linked an issue Apr 2, 2026 that may be closed by this pull request
4 tasks
Paul Mulligan and others added 8 commits April 2, 2026 15:26
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Adds Framework Guides to the documentation map and quickstart
next steps section for discoverability.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@PAMulligan PAMulligan changed the title docs: add error recovery guide for pipeline failures docs: add missing user guides for core framework systems Apr 2, 2026
@PAMulligan PAMulligan self-assigned this Apr 2, 2026
@PAMulligan PAMulligan added the documentation Improvements or additions to documentation label Apr 2, 2026
@PAMulligan PAMulligan added this to the v1.1.0 milestone Apr 2, 2026
@PAMulligan PAMulligan merged commit ee31556 into main Apr 2, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

Add missing user guides for core framework systems

1 participant