docs: remove LLM-style phrasing and sensitive references#26
Merged
Conversation
…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)
Contributor
There was a problem hiding this comment.
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. |
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>
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
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
Cleans up language throughout the documentation.
LLM-style phrasing removed
Key Xheadings and labels (Key Responsibilities,Key Features,Key Takeaways, etc.) with plain equivalentscomprehensiveused as filler in descriptionsTest Milestonetracking blocks from the reimplementation guide — it is informational, not an implementation planrobustin checklistReverse engineering / sensitive references removed
reverse engineerwithdocumentin control modesGrundfos GO mobile appreferenceTraffic analysis and hardware probing confirmedwithTesting confirmedHardware Probingsection toTesting Methodologyin autoadapt_modesReal packet captureswithProtocol sample dataExtracted from the GENI profiletoDefined in the GENI profile