When documenting network connection operations, clearly specify the scope of when operations are supported and their limitations. Include information about initial connection requirements, fallback behaviors, and unsupported scenarios to help users understand operational boundaries.
When documenting network connection operations, clearly specify the scope of when operations are supported and their limitations. Include information about initial connection requirements, fallback behaviors, and unsupported scenarios to help users understand operational boundaries.
For connection management commands, document:
Fallback behaviors (e.g., “this command is equivalent to | :detach | ”) |
Example:
:connect {address}
Detaches the UI from the server it is currently attached to
and attaches it to the server at {address} instead.
Note: If the current UI hasn't implemented the "connect" UI
event, this command is equivalent to |:detach|.
This prevents user confusion and sets proper expectations about connection operation capabilities and constraints.
Enter the URL of a public GitHub repository