Docs refactor — CLAUDE.md signal-to-noise, README as a product pitch#209
Merged
Conversation
CLAUDE.md (573 -> 303 lines): the agent-facing operational guide. Cut the per-chip essays (pointer to the README table), the env-var encyclopedia (DeviceConfig.h field tags are the reference; kept a daily-driver list and the non-obvious measured facts — 8822E 0x41e8 RX desense, CSI-mask inert-vs-jammer, thermal units are not deg C, EVM is the saturation tell, Jaguar3 TX_WITH_RX-before-InitWrite), and the frequency-hopping / bench-init narratives (pointers to docs/). Fixed stale claims: the TX power ramp is described against the live runtime API (not the deprecated SetTxPowerOverride/ApplyTxPower forwarders), change-log phrasing removed, Rtl8812aDevice stated timelessly as a deprecated alias. Defined DEVOURER_RX_ENERGY_MS where linkhealth references it. README (408 -> 183 lines): a product pitch for humans. Chip information lives only in the Supported hardware table; the HAL/dispatch internals stay in CLAUDE.md. Leads with a "Why devourer" differentiator list (no-DKMS, cross-platform, faster-than-kernel startup, per-packet radiotap control, FHSS-speed hopping, 5/10 MHz narrowband), then quick start, an example-binary table in plain language, library usage, and a curated docs/ index (RF primer first). Project layout section removed; the env-var catalogue is a pointer to the env: tags in src/DeviceConfig.h. Jargon is kept out of everything above the library-usage section. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
What
Both top-level docs rewritten for their actual audiences. Net: −873/+375 lines.
README (408 → 183) — a product pitch for humans
env:tags insrc/DeviceConfig.h— one source of truth, nothing to rot.docs/index with the visual RF primer first for newcomers.CLAUDE.md (573 → 303) — the agent-facing operational guide
DeviceConfig.hfield docs), frequency-hopping / bench-init narratives (→docs/).TX_WITH_RX-before-InitWrite, the SDR-not-sniffer bench rule, the canonical-SA three-place convention, generated-tables rule.SetTxPowerOverride/ApplyTxPowerforwarders were still referenced), change-log phrasing ("no ... any more", "previously named ... one release cycle") removed,DEVOURER_RX_ENERGY_MSdefined where it's referenced (a gap in the old text).All 13 README links verified to exist; cross-references between the two files updated.
🤖 Generated with Claude Code