Sniffer: docs and migration for the raw-value sniffer

Open Beginner friendly
#36 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp
Domain
documentation

Research direction

Start with the linked .specs/sniffer.md section on docs and migration, then read the current changelog, README, and RAW_VALUES.md. Update them to cover the specified breaking changes, web_page, the /sniffer URL, requirements, memory cost, security warning, captive portal fallback, and the revised capture workflow. Done when all listed documentation matches the spec.

Written by the indexing model from the issue text.

Description

Spec: Docs and migration

  • Changelog: the breaking changes listed in the spec.
  • Readme: web_page, the /sniffer URL, the web_server_base requirement, memory cost, the open-on-LAN warning without web_server: auth:, captive-portal fallback.
  • RAW_VALUES.md: capture workflow rewritten around the page and its export.
Dominant language
C++
Stars
8
Forks
4
Avg merge
15h 58m
Merged PRs (30d)
5

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from distante/esphome-components

All issues in distante/esphome-components

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.