Skip to content

docs: remove LLM-style phrasing and sensitive references#26

Merged
eman merged 3 commits into
mainfrom
clean-up-docs-language
May 15, 2026
Merged

docs: remove LLM-style phrasing and sensitive references#26
eman merged 3 commits into
mainfrom
clean-up-docs-language

Conversation

@eman
Copy link
Copy Markdown
Owner

@eman eman commented May 15, 2026

Summary

Cleans up language throughout the documentation.

LLM-style phrasing removed

  • Replaced all Key X headings and labels (Key Responsibilities, Key Features, Key Takeaways, etc.) with plain equivalents
  • Removed comprehensive used as filler in descriptions
  • Removed Test Milestone tracking blocks from the reimplementation guide — it is informational, not an implementation plan
  • Fixed robust in checklist

Reverse engineering / sensitive references removed

  • Replaced reverse engineer with document in control modes
  • Removed Grundfos GO mobile app reference
  • Replaced Traffic analysis and hardware probing confirmed with Testing confirmed
  • Renamed Hardware Probing section to Testing Methodology in autoadapt_modes
  • Removed Wireshark BLE capture from recommended tooling lists
  • Replaced Real packet captures with Protocol sample data
  • Changed Extracted from the GENI profile to Defined in the GENI profile
  • Removed specific capture counts and dates from packet trace history

…erences

- Replace 'key X' headings/labels with plain equivalents throughout
- Remove 'comprehensive' filler in descriptions
- Remove 'Test Milestone' tracking blocks from reimplementation guide
- Replace 'reverse engineer' with neutral 'document' in control_modes
- Remove 'Grundfos GO mobile app' reference
- Replace 'Traffic analysis and hardware probing' with 'Testing'
- Rename 'Hardware Probing' section to 'Testing Methodology'
- Remove Wireshark BLE capture references from tooling lists
- Replace 'Real packet captures' with 'Protocol sample data'
- Change 'Extracted from the GENI profile' to 'Defined in the GENI profile'
- Clean up packet trace language (remove specific capture counts and dates)
Copilot AI review requested due to automatic review settings May 15, 2026 15:59
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-focused cleanup to make the docs more neutral/direct (removing “LLM-style” phrasing) while also removing/softening references to reverse engineering, packet captures, and specific tooling that could be considered sensitive.

Changes:

  • Replaced “Key …” headings/labels with simpler equivalents (e.g., “Summary”, “Notes”, “Methods”, “Registers”).
  • Reworded or removed “reverse engineering / capture”-style phrasing and specific references (e.g., Wireshark, Grundfos GO app, capture counts/dates).
  • Removed “Test Milestone” checklist blocks from the reimplementation guide to keep it informational rather than plan-oriented.

Reviewed changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
docs/troubleshooting/service_discovery.md Renames “Key Takeaway” section to “Summary”.
docs/TESTING_STRATEGY.md Rewords overview phrasing; renames “Real packet captures” to “Protocol sample data”.
docs/reimplementation/README.md Removes Wireshark mention from tooling list; renames “Key Concepts” to “Concepts”.
docs/reimplementation/layer_by_layer.md Removes “Test Milestone” blocks; simplifies intro phrasing.
docs/reimplementation/common_pitfalls.md Renames “Key …” callouts; removes Wireshark/logic analyzer recommendations.
docs/reimplementation/checklist.md Changes “Error handling robust” wording to “complete”.
docs/reimplementation/architecture.md Renames “Key Responsibilities” and “Key Design Patterns” headings.
docs/reference/data_models.md Rewords ScheduleEntry description; renames “Key Methods” to “Methods”.
docs/protocol/telemetry.md Renames “Key Registers” to “Registers”.
docs/protocol/schedules.md Replaces “traffic analysis/hardware probing” phrasing; renames “Key …” headings; minor rewording.
docs/protocol/packet_traces/06_alarms_warnings.md Replaces capture-count/date language with “testing” phrasing; renames “Key Discovery”.
docs/protocol/control_modes.md Removes Grundfos GO app mention; replaces “reverse engineer” phrasing with “document”.
docs/protocol/ble_architecture.md Renames “Key Objects/Key Takeaways” sections to plainer labels.
docs/protocol/autoadapt_modes.md Renames “Hardware Probing” section and removes probing script lines.
docs/protocol/architecture.md Renames table column “Key Components” to “Components”.
docs/integrations/esphome.md Renames “Key sections…” phrasing to “Sections…”.
docs/guides/understanding_telemetry.md Removes “key” filler wording in intro sentence.
docs/guides/time_management.md Renames “Key Objects” to “Objects”.
docs/guides/historical_data.md Removes “key metrics” filler wording in trend description.
docs/guides/control_modes.md Rewords intro sentence to be more direct.
docs/api/constants.md Replaces “Extracted from…” with “Defined in…” for ERROR_CODES description.
.gitignore Ignores .obsidian vault directory.

Comment thread docs/protocol/autoadapt_modes.md Outdated
Comment thread docs/TESTING_STRATEGY.md Outdated
eman and others added 2 commits May 15, 2026 09:03
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@eman eman merged commit 8346ccf into main May 15, 2026
6 checks passed
@eman eman deleted the clean-up-docs-language branch May 15, 2026 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants