docs: add comprehensive Web Terminal documentation#20458
Merged
Conversation
Closes #19119 This adds detailed documentation for the Web Terminal feature, covering: - Architecture and how it works (xterm.js + WebSocket) - Font customization options (IBM Plex Mono, Fira Code, etc.) - Rendering engine configuration (canvas, webgl, dom) - Keyboard shortcuts and copy/paste behavior - URL handling and automatic port forwarding - Advanced usage (custom commands, container selection, debug mode) - Configuration options (server and user-side) - Comprehensive troubleshooting guide - Security considerations - Comparison with other access methods The documentation is placed in docs/user-guides/workspace-access/ and linked from the manifest.json navigation structure.
mtojek
commented
Oct 24, 2025
Mermaid is not supported in Coder docs, replaced with text flow description.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
mtojek
commented
Oct 24, 2025
- Add link to xterm.js website in index.md - Remove Performance Issues section - Remove Display Issues section - Remove Copy/Paste Not Working section - Remove Comparison with Other Access Methods section - Remove Security Considerations section - Remove Related Documentation section Keeping only essential documentation as requested.
This comment was marked as resolved.
This comment was marked as resolved.
mtojek
commented
Oct 24, 2025
As requested in review - bringing back Display Issues troubleshooting.
This comment was marked as resolved.
This comment was marked as resolved.
johnstcn
reviewed
Oct 24, 2025
- Clarify that container selection only works with Docker containers - Remove duplicate webTerminalRenderer configuration from Server-Side Configuration section
johnstcn
approved these changes
Oct 24, 2025
Member
johnstcn
left a comment
There was a problem hiding this comment.
Nice work 👍 There's a lot of previously undocumented functionality here.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Adds comprehensive Web Terminal documentation to address user questions from #19119.
What's included
Files changed
docs/user-guides/workspace-access/web-terminal.mddocs/manifest.json(navigation)docs/user-guides/workspace-access/index.mdCloses #19119