docs: document the telemetry component type#333
Open
tyeth wants to merge 1 commit into
Open
Conversation
Adds telemetry to the repository-structure tree and a "Telemetry" section under Component Formats, with the field table and rssi / boot_reason examples. Stacked on top of the telemetry component PR (#332). Co-Authored-By: Claude Opus 4.8 (1M context) <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.
Documents the new telemetry component type in the README. Stacked on top of #332 (base branch
add-telemetry-components) — review/merge that first.What's added
telemetry/entry in the repository-structure tree.telemetryName,valueKind,unit,reportOnce,defaultPeriod) plus Wi-Fi RSSI and Boot Reason (one-shot) examples.Note
The Validate Filenames CI job is expected to report ❌ on this PR because it only allowlists files under
.github/andcomponents/, and this PR edits a top-levelREADME.md. This is the same non-blocking behavior seen on the merged README-rewrite PR #301 — kept out of the component PR (#332) precisely so that one stays fully green.🤖 Generated with Claude Code