Skip to content

Add ad-hoc connection limitations to the documentation#4406

Open
nvidianz wants to merge 2 commits intoNVIDIA:mainfrom
nvidianz:ad-hoc-doc-update
Open

Add ad-hoc connection limitations to the documentation#4406
nvidianz wants to merge 2 commits intoNVIDIA:mainfrom
nvidianz:ad-hoc-doc-update

Conversation

@nvidianz
Copy link
Copy Markdown
Collaborator

@nvidianz nvidianz commented Apr 5, 2026

Summary

  • document ad-hoc connection limitations in the communication configuration guide
  • point the 3rd-party integration guide to the central communication configuration section instead of repeating the same details

Testing

  • not run (docs-only changes)

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps bot commented Apr 5, 2026

Greptile Summary

This documentation-only PR adds an ad-hoc connection limitations section to the Communication Configuration guide and cross-references it from the 3rd-party integration guide, consolidating repeated guidance into a single authoritative location.

The new limitations content is accurate and consistent with the technical details already present in the document (e.g., the "Port Numbers" section correctly notes that ports are dynamically assigned when not explicitly configured).

Confidence Score: 5/5

Safe to merge — documentation-only changes with no code impact.

All changes are RST documentation. The new limitations content is technically accurate, the cross-reference label exists in the target file, and there are no P0 or P1 findings.

No files require special attention.

Vulnerabilities

No security concerns identified.

Important Files Changed

Filename Overview
docs/user_guide/admin_guide/configurations/communication_configuration.rst Adds a 3-bullet limitations block for ad-hoc connections after the existing configuration example; content is accurate and consistent with surrounding documentation.
docs/programming_guide/execution_api_type/3rd_party_integration.rst Adds a single cross-reference line pointing to the :ref:communication_configuration label, which is correctly defined in the target file.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Site A sends message to Site B] --> B{Ad-hoc connection\nenabled?}
    B -- No --> C[Route via Server relay]
    B -- Yes --> D{First message\nto target cell?}
    D -- Yes --> E[Initiate ad-hoc connection\ninitial delay]
    E --> F{Network / firewall\nallows direct connection?}
    F -- Yes --> G[Direct TCP/gRPC connection\nestablished]
    G --> H[Subsequent messages\nuse direct path]
    F -- No --> C
    D -- No --> I{Ad-hoc connection\nalready established?}
    I -- Yes --> H
    I -- No --> C
Loading

Reviews (2): Last reviewed commit: "Merge branch 'main' into ad-hoc-doc-upda..." | Re-trigger Greptile

@nvidianz
Copy link
Copy Markdown
Collaborator Author

nvidianz commented Apr 5, 2026

/build

@nvidianz nvidianz changed the title Add ad-hoc connection documentation limitations Add ad-hoc connection limitations to the documentation Apr 5, 2026
@YuanTingHsieh YuanTingHsieh added the documentation Improvements or additions to documentation label Apr 7, 2026
@YuanTingHsieh
Copy link
Copy Markdown
Collaborator

/build

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants