Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

docs: add comprehensive Web Terminal documentation#20458

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
mtojek merged 7 commits intomainfrom19119-web-terminal
Oct 24, 2025

Conversation

@mtojek
Copy link
Member

@mtojekmtojek commentedOct 24, 2025•
edited
Loading

Adds comprehensive Web Terminal documentation to address user questions from#19119.

What's included

  • Architecture and rendering (xterm.js + WebSocket)
  • Font customization (4 options available)
  • Rendering engine configuration (canvas/webgl/dom)
  • Keyboard shortcuts
  • URL handling and port forwarding
  • Advanced usage (custom commands, container selection, debug mode)
  • Configuration options
  • Troubleshooting (connection and display issues)

Files changed

  • New:docs/user-guides/workspace-access/web-terminal.md
  • Updated:docs/manifest.json (navigation)
  • Updated:docs/user-guides/workspace-access/index.md

Closes#19119

Closes#19119This 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 methodsThe documentation is placed in docs/user-guides/workspace-access/ andlinked from the manifest.json navigation structure.
Mermaid is not supported in Coder docs, replaced with text flow description.
mtojek

This comment was marked as resolved.

- 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 sectionKeeping only essential documentation as requested.
@mtojek

This comment was marked as resolved.

As requested in review - bringing back Display Issues troubleshooting.
@mtojek

This comment was marked as resolved.

@mtojekmtojek marked this pull request as ready for reviewOctober 24, 2025 13:45
@mtojekmtojek requested a review fromjohnstcnOctober 24, 2025 13:45
- Clarify that container selection only works with Docker containers- Remove duplicate webTerminalRenderer configuration from Server-Side Configuration section
@mtojekmtojek requested a review fromjohnstcnOctober 24, 2025 14:10
Copy link
Member

@johnstcnjohnstcn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Nice work 👍 There's a lot of previously undocumented functionality here.

mtojek reacted with heart emoji
@mtojekmtojek merged commitc301a0d intomainOct 24, 2025
30 checks passed
@mtojekmtojek deleted the 19119-web-terminal branchOctober 24, 2025 14:24
@github-actionsgithub-actionsbot locked and limited conversation to collaboratorsOct 24, 2025
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.

Reviewers

@johnstcnjohnstcnjohnstcn approved these changes

Assignees

@mtojekmtojek

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add comprehensive Web Terminal documentation

3 participants

@mtojek@johnstcn
[8]ページ先頭
©2009-2025 Movatter.jp