Update documentation to match current codebase#9
Merged
sirredbeard merged 1 commit intomainfrom Mar 8, 2026
Merged
Conversation
Rewrote README in plain, accessible language. Removed duplicate sections, technical jargon, and formatting clutter. Added trademarks disclaimer. Updated agents.md with current font sizes, input control values, and new sections for ChatInputControl, hotkey infrastructure, efficiency mode, and native interop.
88e9c68 to
645330a
Compare
There was a problem hiding this comment.
Pull request overview
Updates project documentation and adds a CI/CD release pipeline to better reflect the current state of the WinUI 3 taskbar Copilot app.
Changes:
- Rewrites
README.mdin simpler language and documents requirements, release builds, CI/CD workflows, and trademarks. - Updates
agents.mdwith current UI/control details plus new sections describing ChatInputControl, hotkeys, efficiency mode, CI/CD, and native interop. - Adds GitHub Actions workflows for PR builds, manual releases, and automated WinGet manifest submission.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| agents.md | Updates technical/agent-facing documentation to match current UI, controls, and infra. |
| README.md | Rewrites user-facing documentation; adds CI/CD and trademarks sections. |
| .github/workflows/build.yml | Adds PR build + reusable workflow to build/publish artifacts for x64/ARM64. |
| .github/workflows/release.yml | Adds manual release workflow that tags and publishes GitHub Releases from build artifacts. |
| .github/workflows/winget-release.yml | Adds workflow to generate and submit WinGet manifests from GitHub Release assets. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Windows Accessibility API (UI Automation fallback) | ||
| - SQLite for persistence | ||
| - Enter: send message | ||
| - Up/Down arrows: scroll through previous messages |
There was a problem hiding this comment.
The Up/Down shortcut description is inaccurate. In MainWindow.xaml.cs, Up/Down are wired to NavigateHistory(-1/+1) with comments indicating "previous/next command", not scrolling through previous messages. Please update this README section to match the actual behavior (history navigation).
Suggested change
| - Up/Down arrows: scroll through previous messages | |
| - Up/Down arrows: navigate command history (previous/next command) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrote README in plain, accessible language. Removed duplicate sections, technical jargon, and formatting clutter. Added CI/CD workflow descriptions and a trademarks disclaimer.
Updated agents.md with current font sizes, input control values, and new sections for ChatInputControl, hotkey infrastructure, efficiency mode, CI/CD workflows, and native interop.