[gourivarma3]

RDKDEV-1777
Reason for Change: To add Component Documentation for Sysint
Fix: Added the README documentation
Test Procedure: None

I have read the CLA Document and I hereby sign the CLA
Signed-off-by: gourivarma3 gouri_varma@comcast.com

[Copilot]

Copilot review overview

🟡 Changes recommended

Several documented implementations, dependencies, and lifecycle behaviors do not match the current repository.

Review effort: Balanced
Findings: 5

Open (5)

• Update Sysint description to include companion executables · New
• Correct universal script dependency sourcing claim · New
• Distinguish network-up activation from connectivity validation · New
• Remove deleted backup_logs.sh references · New
• Correct dumpbackup.sh artifact handling description · New

What changed in this PR

Adds comprehensive Sysint component documentation covering architecture, lifecycle, integrations, and configuration.

Changes:

• Documents major modules and responsibilities.
• Adds Mermaid lifecycle and interaction diagrams.
• Describes runtime and build-time configuration.

File	Description
README.md	Adds Sysint component documentation.

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[nhanasi]

@gourivarma3 -

1. Please add the Directory Structure
2. Address the Copilot comment which seems valid
3. We have moved many scripts into C based implementations and services are updated. Please use those details in ticket
4. Create the list of file with Functionality Mapping with respecitve Scripts/Service  in Internal Modules Section
5. Please provide explanation of the /etc/configuration files and details of variables used.
6. Reboot Management is new module and its not part of sysint why it is explained here
7. Component Interactions needs more Target Component additions as well

[Copilot]

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

[gourivarma3]

Thankyou @nhanasi. Addressed the comments. Can you please check and approve?

[Copilot]

🟡 Changes recommended

Incorrect operational guidance could cause ignored configuration overrides, mistaken readiness assumptions, or unexpected data loss.

7 open issues

• Clarify maintenance wrapper dispatch and notification behavior · New
• Document distinct whitelist refresh arguments · New
• Correct persistent RFC properties path and fallback documentation · New
• Correct boot ordering claims to match unit dependencies · New
• Document destructive filesystem reformatting in emmc_format.sh · New
• Correct parodus restart ordering and Thunder readiness claims · New
• Distinguish NTP synchronization fallback from confirmed event path · New

5 resolved since last review

• Correct dumpbackup.sh artifact handling description
• Remove deleted backup_logs.sh references
• Distinguish network-up activation from connectivity validation
• Correct universal script dependency sourcing claim
• Update Sysint description to include companion executables

_{Review effort: Balanced}

[Copilot]

🟡 Changes recommended

Inaccurate integration and configuration contracts could mislead consumers and operators.

6 open issues

• Remove incorrect daemon-selection attribution from getPartnerProperty.sh · New
• Document secure-dump cache behavior within the same boot · New
• Correct Dobby reset scope and case-sensitive unit name · New
• Document directed D-Bus destinations for time-event signals · New
• Document actual network counter telemetry API and markers · New
• Remove network-up.timer from INTERNET_FULLY_CONNECTED triggers · New

7 resolved since last review

• Distinguish NTP synchronization fallback from confirmed event path
• Correct parodus restart ordering and Thunder readiness claims
• Document destructive filesystem reformatting in emmc_format.sh
• Correct boot ordering claims to match unit dependencies
• Correct persistent RFC properties path and fallback documentation
• Document distinct whitelist refresh arguments
• Clarify maintenance wrapper dispatch and notification behavior

_{Review effort: Balanced}

[Copilot]

🟡 Changes recommended

The storage reference describes a potentially destructive script as validation-only, risking data loss if followed.

3 open issues

• Launcher schedules recurring dummy-data dumps, not telemetry collection · New
• disk_checkV2 may reformat disks and destroy existing data · New
• USB HID loads unconditionally; only storage loading is RFC-controlled · New

6 resolved since last review

• Remove network-up.timer from INTERNET_FULLY_CONNECTED triggers
• Document actual network counter telemetry API and markers
• Document directed D-Bus destinations for time-event signals
• Correct Dobby reset scope and case-sensitive unit name
• Document secure-dump cache behavior within the same boot
• Remove incorrect daemon-selection attribution from getPartnerProperty.sh

_{Review effort: Balanced}

[Copilot]

🟢 Approval recommended

The changes are documentation-only, and the remaining accuracy corrections are non-blocking.

No open issues 🎉

2 previously missed issues

In code that hasn't changed since last review

Documented WiFi driver-health monitoring is inactive

README.md:66

The recovery script does not execute WiFi driver-health checks: checkWifiDrvErrors() is defined but never called, and WifiResetIntervalForDriverIssue does not trigger recovery. Here and in docs/DESIGN.md:145, describe the active behavior instead: when NwSelfHealScriptEnable is enabled, the script checks connectivity, gateway packet loss, and DNS configuration; sustained WiFi packet loss can trigger reassociation and, when WiFiReset.Enable is enabled, a restart of wifi.service. Remove the driver-health monitoring claim so operators do not rely on an inactive check.

Incorrect NetworkManager configuration path and installation guidance

docs/​CONFIGURATION.md:33

/etc/10-unmanaged-devices is not a default NetworkManager configuration location, and the Makefile does not install the source file there. Editing that path would leave the exclusions unapplied. Label this entry and the reference at line 33 as repository source, and explain that platform integration must install a .conf snippet under a NetworkManager configuration directory such as /etc/NetworkManager/conf.d/. Do not imply a deployed filename without checking the image recipe.

3 resolved since last review

• USB HID loads unconditionally; only storage loading is RFC-controlled
• disk_checkV2 may reformat disks and destroy existing data
• Launcher schedules recurring dummy-data dumps, not telemetry collection

_{Review effort: Balanced}

[gourivarma3]

The Documentation is now split into DESIGN.md, CONFIGURATION.md, and INTERACTIONS.md in docs folder. Updated README.md and addressed review comments