Skip to content

Add DEVELOPMENT.md — contributor setup and architecture docs#8

Merged
shanselman merged 5 commits intomasterfrom
copilot/add-development-docs
Feb 2, 2026
Merged

Add DEVELOPMENT.md — contributor setup and architecture docs#8
shanselman merged 5 commits intomasterfrom
copilot/add-development-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Feb 1, 2026

  • Create comprehensive DEVELOPMENT.md in repository root
    • Prerequisites section (SDK, Windows, WebView2, Gateway)
    • Project structure overview (Tray app, Shared library, Command Palette)
    • Building instructions (dotnet build, platform notes, debug mode)
    • Architecture overview (Gateway WebSocket, Events, WebView2, GDI, Sessions, Logging)
    • Testing instructions (without live gateway, manual scenarios)
    • CI/CD overview (GitHub Actions workflow)
  • Verify accuracy and test build instructions
  • Address all code review feedback
    • Naming clarification (Moltbot → OpenClaw)
    • Remove hardcoded test count
    • Update to .NET 10 SDK requirement
  • Final validation complete
Original prompt

This section details on the original issue you should resolve

<issue_title>DEVELOPMENT.md — contributor setup and architecture docs</issue_title>
<issue_description>## Summary
Add a DEVELOPMENT.md file documenting how to build, run, and contribute to the project.

Suggested Contents

Prerequisites

  • .NET 9 SDK
  • Windows 10/11 (WinUI3/WindowsAppSDK dependency)
  • WebView2 Runtime (usually pre-installed on Windows 10+)
  • A running Clawdbot gateway instance for testing

Project Structure

  • Overview of the solution layout: Tray app, Shared library, PowerToys extension
  • Which projects depend on what
  • Where the gateway communication layer lives
  • How the notification system works (event types, categories, routing)

Building

  • dotnet build from solution root
  • Any platform/architecture notes (arm64 vs x64)
  • How to run in debug mode with Visual Studio or dotnet run

Architecture Overview

  • Gateway SSE connection and reconnect/backoff logic
  • Event parsing and structured notification types
  • WebView2 lifecycle (WebChat panel, future Canvas panel)
  • GDI handle management (icon creation/destruction pattern)
  • Session tracking and polling
  • Logging (file rotation, debug output)

Testing

  • How to test without a live gateway
  • Manual test scenarios for tray icon states, notifications, WebChat

CI

  • GitHub Actions workflow overview
  • What the CI build checks

Why This Matters

The repo is public and the project has a few moving parts (SSE streaming, WinUI3 tray, WebView2, PowerToys integration). Good contributor docs lower the barrier for PRs and help people understand the design decisions already made.

Acceptance Criteria

  • DEVELOPMENT.md exists in repo root
  • Covers build steps, prerequisites, and project structure
  • Includes architecture overview with key design decisions
  • Accurate and tested (someone can follow it cold and get a working build)</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits February 1, 2026 06:53
…ions

Co-authored-by: shanselman <2892+shanselman@users.noreply.github.com>
Co-authored-by: shanselman <2892+shanselman@users.noreply.github.com>
Co-authored-by: shanselman <2892+shanselman@users.noreply.github.com>
Copilot AI changed the title [WIP] Add DEVELOPMENT.md for contributor setup and architecture Add DEVELOPMENT.md — contributor setup and architecture docs Feb 1, 2026
Copilot AI requested a review from shanselman February 1, 2026 06:56
@shanselman
Copy link
Copy Markdown
Collaborator

@copilot are we all on .net 10 now? If so update this

Co-authored-by: shanselman <2892+shanselman@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Feb 2, 2026

@copilot are we all on .net 10 now? If so update this

Updated to require .NET 10 SDK in commit 03c9128

@shanselman shanselman marked this pull request as ready for review February 2, 2026 07:20
@shanselman shanselman merged commit caad33f into master Feb 2, 2026
@shanselman shanselman deleted the copilot/add-development-docs branch February 8, 2026 02:22
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.

DEVELOPMENT.md — contributor setup and architecture docs

2 participants