Skip to content

docs: README HID/mDNS facts, LICENSE year, chore/ branch - #769

Merged
tylerkron merged 2 commits into
mainfrom
cursor/docs-readme-hid-mdns-license-77d8
Sep 27, 2026
Merged

docs: README HID/mDNS facts, LICENSE year, chore/ branch#769
tylerkron merged 2 commits into
mainfrom
cursor/docs-readme-hid-mdns-license-77d8

Conversation

@tylerkron

@tylerkron tylerkron commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

What was wrong

#757 and #762 correct the Core XML and CONTRIBUTING gating, but they left four consumer-facing facts out of date:

  • The README called HID a HidSharp backend on every platform. HidSharp finds no HID devices on macOS (HidSharp enumerates 0 HID devices on macOS — blocks PIC32 firmware update #262). The transport has used IOKit there since feat(hid): native IOKit HID backend for macOS (closes #262) #263 (HidPlatformFactory: macOS → MacOsHidPlatform, everything else → HidLibraryPlatform). docs(core): fix DeviceMetadata.Health and HID finder XML #757 fixes the class summaries, but the README's Connection types list still said HidSharp for every platform.
  • README discovery listed UDP 30303 only. The recipe already documents MDnsDeviceFinder (_daqifi._tcp.local. on 224.0.0.251:5353), but Connection types and Requirements never mentioned multicast. Someone configuring a firewall from Requirements would open 30303 and miss 5353.
  • LICENSE still said 2025. The repo started in March 2025 and has commits from 2026.
  • The CONTRIBUTING branch prefixes left out chore/. .claude/rules/git-workflow.md lists feature/, fix/, chore/ and docs/, and says CONTRIBUTING.md owns branch names. CONTRIBUTING only listed three of those.

How it was fixed

Docs only: no C#, no Core XML, and no rewrite of the gating rules.

  • README Connection types: WiFi is found by UDP broadcast on 30303, and also by mDNS (_daqifi._tcp.local., UDP 5353 multicast) when you add MDnsDeviceFinder. mDNS is opt-in because AllTransportsDeviceFinder.CreateDefault() covers only WiFi broadcast and serial. The HID wording matches docs(core): fix DeviceMetadata.Health and HID finder XML #757: HidSharp on Windows and Linux, native IOKit on macOS, with an absolute link to #262. README.md is the packed NuGet readme, and a bare #262 doesn't link in a rendered repo file or on nuget.org.
  • README Requirements: WiFi discovery needs 30303 (broadcast), plus UDP 5353 multicast (224.0.0.251) if you use MDnsDeviceFinder.
  • LICENSE: 2025-2026. The original year stays.
  • CONTRIBUTING.md: chore/short-description added to the branch-prefix list. Nothing else in the file changes.

Out of scope (owned elsewhere)

None of the hunks here overlap the README/CONTRIBUTING hunks in #762, #775 or #800.

Verification

Checked against HidPlatformFactory, MDnsDeviceFinder / MDnsMessage.MulticastPort (5353, group 224.0.0.251), WiFiDeviceFinder.DefaultDiscoveryPort (30303) and AllTransportsDeviceFinder.CreateDefault(). dotnet build Daqifi.Core.sln is clean (0 warnings, 0 errors).

🤖 Generated with Claude Code

@cursoragent @tylerkron
docs: README HID/mDNS facts, LICENSE year, chore/ branch
49495a4 
README still called HID a HidSharp backend and listed WiFi discovery as
UDP 30303 only. HID is HidSharp on Windows/Linux and IOKit on macOS (#262);
discovery also browses _daqifi._tcp.local. on 5353. LICENSE year and the
chore/ branch prefix were the leftover housekeeping #762 didn't cover.

Co-authored-by: Tyler Kron <tylerkron@gmail.com>
@tylerkron
tylerkron requested a review from a team as a code owner September 21, 2026 10:15
@qodo-code-review

qodo-code-review Bot commented Sep 21, 2026

Copy link
Copy Markdown

PR Summary by Qodo

Correct HID and mDNS documentation and repository metadata

📝 Documentation 🕐 Less than 10 minutes

Grey Divider

AI Description 

• Document mDNS discovery ports and platform-specific HID backends.
• Add chore/ to accepted branch naming conventions.
• Extend DAQiFi copyright coverage through 2026.
High-Level Assessment

Directly correcting the consumer-facing documentation and repository metadata is the optimal approach. Runtime HID, discovery, and contribution-gating changes were appropriately excluded because the underlying behavior already exists or is owned by separate work.

Files changed (3) +7 / -5

Documentation (3) +7 / -5
CONTRIBUTING.mdDocument the chore branch prefix +1/-1

Document the chore branch prefix

• Adds 'chore/short-description' to the supported branch naming examples alongside feature, fix, and documentation branches.

CONTRIBUTING.md

LICENSEExtend the copyright year through 2026 +1/-1

Extend the copyright year through 2026

• Updates DAQiFi's copyright notice from 2025 to the 2025–2026 range.

LICENSE

README.mdClarify mDNS discovery and platform-specific HID support +5/-3

Clarify mDNS discovery and platform-specific HID support

• Documents WiFi discovery over both UDP broadcast port 30303 and mDNS multicast port 5353. Clarifies that HID uses HidSharp on Windows and Linux but native IOKit on macOS.

README.md

@qodo-code-review

qodo-code-review Bot commented Sep 21, 2026 •
edited
Loading

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day 
💡 Did you know, you can describe a rule in plain language on the Rules page and Qodo drafts it for you

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Previous reviews

Review updated until commit bcb00d8 ⏭️ Skipped

Results up to commit 49495a4 🚀 Fast


No changes from previous review

Results up to commit bcb00d8 ⏭️ Skipped


No changes from previous review

Grey Divider

Qodo Logo

@tylerkron @claude
docs(readme): mark mDNS as opt-in and link #262 absolutely
bcb00d8 
MDnsDeviceFinder is not in AllTransportsDeviceFinder.CreateDefault(), so
5353 is only needed when a consumer adds it. The bare #262 does not
autolink in a rendered repo file or on nuget.org.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@tylerkron

tylerkron commented Sep 27, 2026

Copy link
Copy Markdown
Contributor Author

/agentic_review

@qodo-code-review

qodo-code-review Bot commented Sep 27, 2026

Copy link
Copy Markdown

Code review by qodo was updated up to the latest commit bcb00d8

@tylerkron

tylerkron commented Sep 27, 2026

Copy link
Copy Markdown
Contributor Author

/agentic_review

@qodo-code-review

qodo-code-review Bot commented Sep 27, 2026

Copy link
Copy Markdown

Code review by qodo was updated up to the latest commit bcb00d8

@tylerkron

tylerkron commented Sep 27, 2026

Copy link
Copy Markdown
Contributor Author

Qodo-clean, CI green — ready for review

@tylerkron tylerkron mentioned this pull request Sep 27, 2026
Merged
@tylerkron
tylerkron added this pull request to the merge queue Sep 27, 2026
Merged via the queue into main with commit 9b0a889 Sep 27, 2026
4 checks passed
@tylerkron
tylerkron deleted the cursor/docs-readme-hid-mdns-license-77d8 branch September 27, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@tylerkron @cursoragent