docs: document iron-remote-desktop API design philosophy#1192
Merged
Benoît Cortier (CBenoit) merged 9 commits intomasterfrom Mar 31, 2026
Merged
Conversation
The core rules is: a method belongs in the base API (UserInteraction / Session / SessionBuilder) if the web component itself needs to call it for transparent behaviour, or if the feature is universal across all remote protocol backends. Protocol-specific concepts must go through the extension mechanism instead.
There was a problem hiding this comment.
Pull request overview
This PR documents the intended API boundary and layering rules for the iron-remote-desktop web component / NPM package and its backend extension mechanism, aiming to keep the base API protocol-agnostic and push protocol-specific features into backend extensions.
Changes:
- Adds a “Design Philosophy” section explaining protocol-agnostic boundaries and the extension mechanism.
- Updates the web-client README API guidance to emphasize
ConfigBuilder+ extensions rather than protocol-specificconnect(...)parameters. - Codifies the same invariant in repo-level docs (
ARCHITECTURE.md,AGENTS.md) and the Rust helper crate README.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| web-client/iron-remote-desktop/README.md | Adds protocol-agnostic design rules + extension mechanism docs; updates public API usage docs. |
| crates/iron-remote-desktop/README.md | Documents the same protocol-agnostic philosophy for the Rust-side traits and extension passthrough. |
| ARCHITECTURE.md | Adds an architectural invariant for the web-client layering and extension mechanism. |
| AGENTS.md | Adds guidance for contributors/reviewers to enforce the web-client layering and extension rule. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Benoît Cortier (@CBenoit) It's like you're reading my mind. Thank you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Marc-André Moreau (mamoreau-devolutions)
approved these changes
Mar 31, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Coverage Report 🤖 ⚙️Past: New: Diff: +0.00% [this comment will be updated automatically] |
Benoît Cortier (CBenoit)
deleted the
docs/document-iron-remote-desktop-design-philosophy
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The core rule is: a method belongs in the base API (UserInteraction / Session / SessionBuilder) if the web component itself needs to call it for transparent behaviour, or if the feature is universal across all remote protocol backends. Protocol-specific concepts must go through the extension mechanism instead.