docs: rewrite README with marketing positioning and cross-platform emphasis#530
Open
tylerkron wants to merge 5 commits into
Open
docs: rewrite README with marketing positioning and cross-platform emphasis#530tylerkron wants to merge 5 commits into
tylerkron wants to merge 5 commits into
Conversation
…phasis Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Contributor
Review Summary by QodoRewrite README with marketing positioning and structured documentation
WalkthroughsDescription• Rewrites README with marketing positioning and brand voice • Adds structured sections: hero, quick install, applications, ecosystem table • Replaces sparse tech-stack bullets with verified capability table • Adds CI, license, platform, and .NET badges with correct links • Includes device specifications, WiFi connectivity guide, and requirements • Reorganizes troubleshooting and port reference content • Adds community support links and maintainer release instructions Diagramflowchart LR
A["Original README<br/>81 lines, sparse"] -->|"Add brand voice<br/>and hero section"| B["Marketing Hero<br/>with tagline"]
A -->|"Replace tech bullets<br/>with tables"| C["Capability Table<br/>Device Specs"]
A -->|"Add badges and links"| D["CI, License, Platform<br/>Badges"]
A -->|"Reorganize content"| E["Structured Sections<br/>Quick Install, Apps"]
B --> F["New README<br/>155 lines, structured"]
C --> F
D --> F
E --> F
File Changes1. README.md
|
Contributor
Code Review by Qodo
1.
|
…rofiles description Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
…not tag push) Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Contributor
Author
|
Addressing all three Qodo review items: 1. Long lines over 120 characters (Rule violation) Disagreed — not fixing. The 120-character limit in 2. MSI runtime claim wrong (Bug — ✓ already resolved) Fixed in the prior commit ( 3. Release trigger doc mismatch (Bug) Fixed in commit |
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Pulls the data-flow diagram out of the README into docs/architecture.md and rewrites it against the actual code: - StreamMessageConsumer / ProtobufMessageParser no longer exist; protobuf decoding now happens in Daqifi.Core's ProtobufProtocolHandler - IChannel.ActiveSample setter is what applies NCalc scaling and fires OnChannelUpdated - LoggingManager iterates a list of ILoggers (DatabaseLogger, PlotLogger, SummaryLogger), not just DatabaseLogger - DatabaseLogger uses a BlockingCollection consumer thread that bulk- inserts via EFCore.BulkExtensions every ~100 ms Adds C4 System Context and Container diagrams so contributors can see where DAQiFi Desktop sits relative to Nyquist hardware, Sentry, GitHub Releases, and the Windows Firewall. Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
📊 Code Coverage ReportSummarySummary
CoverageDAQiFi - 19.1%
Daqifi.Desktop.Common - 30.8%
Daqifi.Desktop.IO - 100%
Coverage report generated by ReportGenerator • View full report in build artifacts |
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
1 participant
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.
Summary
build.yaml)What changed vs. the original
Test plan
build.yamlworkflow, license badge links toLICENSEConnectedDeviceslist), CSV export (.csvfilter), NCalc scaling (AbstractChannel), HID firmware update (HidLibraryTransport), profiles (ProfilesPaneViewModel)net10.0-windows, WPF)🤖 Generated with Claude Code