[gourivarma3]

RDKDEV-1794
Reason for Change: To add Component Documentation for firebolt-cpp-transport.
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]

🟡 Changes recommended

Several documented connection, retry, callback-threading, and lifecycle behaviors do not match the implementation.

10 open findings

• Clarify inbound and outbound data flows · New
• Document that disconnect does not clear event callbacks · New
• Correct the connection callback thread contract · New
• Remove unsupported retry and synchronous availability claims · New
• Correct watchdog lifecycle description · New
• Clarify that event notifications are inbound · New
• Correct event message definition for legacy mode · New
• Narrow return type claims to transport operations · New
• Document or implement unused retry configuration · New
• Identify the external Yocto recipe or clarify ownership · New

What changed in this PR

Adds comprehensive component documentation for the C++ transport library.

Changes:

• Documents architecture, threading, lifecycle, call flows, and configuration.
• Adds Mermaid diagrams and module interaction details.

File	Description
docs/​README.md	Adds component design and operational documentation.

🧠 Review effort: Balanced

---

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

[Copilot]

🟡 Changes recommended

Several documented API and lifecycle contracts contradict the implementation and could mislead SDK integrations.

17 open issues

• Document that disconnect preserves event callback registrations · New
• Document connection callback thread and blocking restrictions · New
• Document asynchronous connect readiness and remove retry guarantee · New
• Correct watchdog lifecycle and startup documentation · New
• Remove internal send() from the public API documentation · New
• Correct IHelper get() and setter API documentation · New
• Mark unused connection retry configuration fields · New
• Identify the external Yocto recipe or clarify ownership
• Document or implement unused retry configuration
• Narrow return type claims to transport operations
• Correct event message definition for legacy mode
• Clarify that event notifications are inbound
• Correct watchdog lifecycle description
• Remove unsupported retry and synchronous availability claims
• Correct the connection callback thread contract
• Document that disconnect does not clear event callbacks
• Clarify inbound and outbound data flows

_{Review effort: Balanced}

[Copilot]

🟡 Changes recommended

The lifecycle documentation incorrectly implies that remote disconnection releases transport resources.

1 open issue

• Clarify that disconnection does not release transport resources · New

7 resolved since last review

• Mark unused connection retry configuration fields
• Correct IHelper get() and setter API documentation
• Remove internal send() from the public API documentation
• Correct watchdog lifecycle and startup documentation
• Document asynchronous connect readiness and remove retry guarantee
• Document connection callback thread and blocking restrictions
• Document that disconnect preserves event callback registrations

_{Review effort: Balanced}

[Copilot]

🟢 Approval recommended

The documentation addresses prior feedback, and no unresolved blocking issues remain.

No open issues 🎉

1 resolved since last review

• Clarify that disconnection does not release transport resources

_{Review effort: Balanced}

[gourivarma3]

Review comments are addressed