Skip to content

docs: Add DruidUI framework documentation#27

Merged
druid-infra merged 6 commits intomasterfrom
feat/druidui-docs
Feb 10, 2026
Merged

docs: Add DruidUI framework documentation#27
druid-infra merged 6 commits intomasterfrom
feat/druidui-docs

Conversation

@druid-infra
Copy link
Contributor

Summary

Comprehensive documentation for DruidUI, Druid's WebAssembly-based UI framework for building sandboxed user interfaces.

Content

  • Introduction: What DruidUI is and why it exists
  • Quick Start: Installation and first component
  • Core Concepts: Components, rendering, context
  • Development Workflow: Sandbox vs raw mode, Vite plugin
  • Architecture: Component lifecycle, host↔WASM interface
  • Multi-Language Support: Current (JS/TS) and future (Rust/C++)
  • Extension System: Custom APIs with WIT interfaces
  • Performance: Bundle size, speed, memory usage
  • Best Practices: State management, optimization tips
  • Migration Guides: From React and Vue

Key Features Documented

✅ React-like JSX/TSX components
✅ WebAssembly sandboxing for security
✅ Hot reloading with Vite
✅ Extension system for platform APIs
✅ Shadow DOM encapsulation
✅ Multi-language support (roadmap)

Target Audience

  • Developers building custom UIs for scrolls
  • Platform developers adding UI extensibility
  • Anyone interested in sandboxed web frameworks

Position: docs/druid-ui/ (new section)

- Explain WebAssembly SPA framework architecture
- Detail sandboxing benefits and use cases
- Provide quick start guide and examples
- Document component model and rendering
- Cover extension system for custom APIs
- Include multi-language support roadmap
- Add migration guides from React/Vue
- Performance metrics and best practices
@druid-infra
Copy link
Contributor Author

Error: This repo is not allowlisted for Atlantis.

@cloudflare-workers-and-pages
Copy link
Contributor

cloudflare-workers-and-pages bot commented Feb 10, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
docs df51da7 Commit Preview URL

Branch Preview URL
Feb 10 2026, 03:13 PM

Lugh (Druid Bot) added 5 commits February 10, 2026 14:09
- Remove non-existent file references (api-reference, extensions, deployment)
- Replace < with &lt; in markdown
- Fixes MDX compilation and broken link errors
- Add detailed Mithril.js comparison in introduction
- Create comprehensive @druid-ui/component package docs
- Create @druid-ui/build package docs with CLI and API reference
- Add packages category for NPM package documentation
- Add create-druid-ui package docs (scaffolding tool)
- Add @druid-ui/vite package docs (Vite plugin, HMR)
- Add @druid-ui/host package docs (browser runtime)
- All 5 NPM packages now fully documented
- Comprehensive API references, examples, troubleshooting
- Build passing successfully
- Removed entire Migration Guide section (React, Vue examples)
- Keep documentation focused on DruidUI itself
- Users can figure out migration on their own
@druid-infra druid-infra merged commit 066f845 into master Feb 10, 2026
2 checks passed
@druid-infra druid-infra deleted the feat/druidui-docs branch February 10, 2026 15:16
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