Skip to content

docs: add frontend architecture, testing, bindings, and widget dev guides#652

Merged
rgbkrk merged 1 commit intomainfrom
quill/docs-sync
Mar 9, 2026
Merged

docs: add frontend architecture, testing, bindings, and widget dev guides#652
rgbkrk merged 1 commit intomainfrom
quill/docs-sync

Conversation

@rgbkrk
Copy link
Copy Markdown
Member

@rgbkrk rgbkrk commented Mar 9, 2026

Summary

Added four comprehensive developer guides addressing high-priority documentation gaps:

  • frontend-architecture.md — Explains src/ (shared components) vs apps/notebook/src/ (app-specific), path aliases, component organization, and data flow
  • testing.md — Unified guide covering Vitest (frontend), Rust unit tests, Hone CLI tests, Python integration tests, and E2E
  • typescript-bindings.md — Documents the ts-rs workflow for auto-generating TypeScript types from Rust
  • widget-development.md — Widget system internals, WidgetStore API, Comm bridge protocol, and adding new widgets

Also expanded contributing/architecture.md with blob store implementation details under Principle 5.

Test Plan

  • Review each new doc for accuracy and completeness against the codebase
  • Verify all file paths and code references exist
  • Cross-check internal links between docs work correctly

PR submitted by @rgbkrk's agent, Quill

…ides

Add comprehensive documentation for developers:
- contributing/frontend-architecture.md: src/ vs apps/notebook/src/ split, path aliases, data flow
- contributing/testing.md: unified testing guide (Vitest, Rust, Hone, Python, E2E)
- contributing/typescript-bindings.md: ts-rs workflow for Rust → TypeScript types
- contributing/widget-development.md: widget system internals, WidgetStore API, adding widgets
- contributing/architecture.md: expanded Principle 5 with blob store implementation details

Addresses high-priority documentation gaps from gap analysis (#1-4) without multi-window sync docs as requested.
@rgbkrk rgbkrk force-pushed the quill/docs-sync branch from aca53fa to 008d93c Compare March 9, 2026 16:33
@rgbkrk rgbkrk merged commit 074ab0b into main Mar 9, 2026
9 of 10 checks passed
@rgbkrk rgbkrk deleted the quill/docs-sync branch March 9, 2026 17:12
@rgbkrk rgbkrk added quill PR authored by Quill Agent 🦆 documentation Improvements or additions to documentation ipywidgets Widget rendering, comm protocol, Output widgets frontend Webview, React, TypeScript UI test Test infrastructure and coverage labels Mar 14, 2026
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 frontend Webview, React, TypeScript UI ipywidgets Widget rendering, comm protocol, Output widgets quill PR authored by Quill Agent 🦆 test Test infrastructure and coverage

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant