Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 2, 2026

Pull Request – Simulation Only

Summary

Eliminated redundant content in README.md by consolidating duplicate information into single authoritative sections and replacing repetitions with internal anchor links. Reduced file from 231 to 226 lines while maintaining complete information.

Key consolidations:

  • Bedrock SHA256 checksum (3 mentions → 1 detailed + 2 links): Removed duplicate explanations from Requirements and Auto-Update sections; consolidated details in "Integrity & Firewall"
  • Screen socket setup (3 mentions → 1 detailed + 2 links): Enhanced Quickstart/Troubleshooting notes with actionable context; kept full /run/screen commands in "Integrity & Firewall"
  • Workflow documentation (3 mentions → 1 combined): Merged separate SIMULATION.md and copilot-instructions.md references into single sentence

Example change:

- **Note:** JVM memory is auto-sized by the installer (see below). Bedrock installer enforces SHA256 checksum by default.
+ **Note:** JVM memory is auto-sized by the installer (see [Configuration](#configuration)).
-> Bedrock requires a manual download. `setup_bedrock.sh` enforces SHA256 by default (see below).
-> **Checksum enforcement:** Bedrock installer requires `REQUIRED_BEDROCK_SHA256` and validates the ZIP before extraction.
+> Bedrock requires a manual download. See [Integrity & Firewall](#integrity--firewall) for checksum enforcement details.

Checklist

  • No commands executed locally; all steps are simulated/explained only.
  • Changes are limited to scripts and/or documentation.
  • SIMULATION.md updated to reflect behavior and risks.
  • If adding a new script or option, included example usage commands (chmod +x; ./script; screen -r ...).
  • Security considerations addressed (least-privilege user, ports, backups).

Testing (Simulation)

No runtime behavior changes. Documentation-only modifications. All internal anchor links verified against section headers:

  • #configuration## Configuration
  • #integrity--firewall## Integrity & Firewall

Rollback: git revert or restore previous README.md version.

Original prompt

Kurze Zusammenfassung:

  • Inhaltlich ist die README schlüssig und konsistent aufgebaut (Features → Quickstart → Pflichtschritt Upstream DNS → Checks → Architektur → API → Troubleshooting → Security → Contributing → Changelog).
  • Keine harten Dopplungen ganzer Abschnitte, aber es gibt Wiederholungen desselben Themas:
  1. Post-Install Check / post_install_check.sh
    Das Thema kommt zweimal relativ ausführlich vor:

    • Erster Block: „## ✅ Post-Install Verification (post_install_check.sh)“ (Zeilen ~107–171) – mit Optionen, Help-Text, Interaktivmodus.
    • Zweiter Block: „## 🧪 Health Checks & Troubleshooting → Post-Install Check Script“ (Zeilen ~297–371) – nochmals dieselben Befehle und sehr ähnlicher Help-Text + Menü + Erklärung, was geprüft wird.
      Vorschlag:
    • Ersten Block als „Kurzfassung“ belassen (2–3 Kommandos, 2–3 Bulletpoints).
    • Im Troubleshooting-Teil nur verlinken („Details siehe oben“) oder umgekehrt, aber nicht beide Blöcke komplett ausschreiben.
  2. Upstream-Konfiguration / 127.0.0.1#5335 / pihole.toml

    • Früher Abschnitt „🔴 Required Step: Ensure Pi-hole Uses Unbound“ erklärt sehr ausführlich das Konzept inkl. Screenshot.
    • Später bei „Pi-hole v6 Configuration Note“ (Zeilen ~396–405) wird dieselbe Info (pihole.toml, [dns] upstreams = ["127.0.0.1#5335"]) erneut erklärt.
      Vorschlag:
    • Im späteren Abschnitt nur noch als Reminder formulieren („Wie oben beschrieben…“) und auf den Pflichtschritt verlinken, anstatt die Konfiguration erneut auszuschreiben.
  3. Kommando-Wiederholungen

    • ./scripts/post_install_check.sh --quick/--full/--urls/--steps taucht in voller Liste zweimal auf.
    • Die Beschreibung des interaktiven Menüs („Quick Check, Full Check, Show URLs, …“) ist ebenfalls doppelt.
      Vorschlag:
    • Einmal zentrale „Command-Referenz“ im Post-Install-Abschnitt.
    • Im Troubleshooting-Teil nur 1–2 Beispielbefehle mit Link/Verweis auf die Referenz.
  4. Kleinere Punkte

    • Quickstart ist knapp und nicht doppelt.
    • API-Referenz und Security-Abschnitt sind eindeutig, dort sehe ich keine unnötigen Wiederholungen.

Wenn du möchtest, kann ich dir einen konkreten Vorschlag als Patch (Diff) formulieren, der:

  • den ersten Post-Install-Block auf „Kurzfassung“ reduziert,
  • im Troubleshooting-Block nur die erweiterten Infos lässt und
  • bei der Pi-hole-v6-Notiz auf den „Required Step“-Abschnitt verweist.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 2, 2026 20:44
Co-authored-by: TimInTech <129355283+TimInTech@users.noreply.github.com>
Co-authored-by: TimInTech <129355283+TimInTech@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README to reduce duplication in post-install check section docs: eliminate README redundancies via consolidation and cross-references Jan 2, 2026
Copilot AI requested a review from TimInTech January 2, 2026 20:48
@TimInTech TimInTech marked this pull request as ready for review January 2, 2026 20:48
Copilot AI review requested due to automatic review settings January 2, 2026 20:48
@TimInTech TimInTech merged commit 7139431 into main Jan 2, 2026
4 checks passed
@TimInTech TimInTech deleted the copilot/update-readme-post-install-check branch January 2, 2026 20:49
Copy link

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

This PR eliminates redundant content in README.md by consolidating duplicate information into single authoritative sections and replacing repetitions with internal cross-reference links. The changes reduce the file from 231 to 226 lines while preserving all information.

Key improvements:

  • Consolidated 3 mentions of Bedrock SHA256 checksum into 1 detailed section with 2 cross-references
  • Consolidated 3 mentions of screen socket setup into 1 detailed section with 2 cross-references
  • Merged 3 separate workflow documentation references into a single concise sentence

Reviewed changes

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md (line 36) Removed duplicate "Bedrock installer enforces SHA256" note; retained auto-sizing reference with link to Configuration section
README.md (line 72) Converted screen socket setup note to contextual error-handling reference linking to Integrity & Firewall section
README.md (line 162) Consolidated duplicate Bedrock checksum explanations into single cross-reference to Integrity & Firewall section
README.md (line 210) Replaced verbose troubleshooting note with cross-reference to Integrity & Firewall section
README.md (line 213) Combined three separate workflow document references into one consolidated sentence with both links

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