Skip to content

[playwright vscode extension] Add getting started instructions to README#5592

Merged
TheLarkInn merged 2 commits into
mainfrom
copilot/update-readme-browser-tunnel-instructions
Feb 4, 2026
Merged

[playwright vscode extension] Add getting started instructions to README#5592
TheLarkInn merged 2 commits into
mainfrom
copilot/update-readme-browser-tunnel-instructions

Conversation

Copilot AI commented Feb 3, 2026

Copy link
Copy Markdown
Contributor

The extension README was missing setup instructions for users, specifically how to start the browser tunnel and key configuration requirements.

Changes

  • Getting Started section: Step-by-step instructions for starting/stopping the tunnel via Command Palette
  • Requirements section: Documents terminal.integrated.shellIntegration.enabled must be enabled
  • Auto-starting section: Shows workspace settings configuration with security note

Example workspace config

{
  "playwright-local-browser-server.autoStart": true
}
Original prompt

This section details on the original issue you should resolve

<issue_title>[playwright-local-browser-server] Provide instructions for starting browser server</issue_title>
<issue_description>In ./vscode-extensions/playwright-on-codespaces-vscode-extension/README.md, we do not instruct users to start the browser tunnel first.

  • Write a blurb that instructions users to start the browser tunnel (and how to do so from the vscode command palette)
  • Mention that this extension requires that terminal.integrated.shellIntegration.enabled setting must be true for this extension to work
  • Also mention that developers can set autostart: true in their .vscode workspace settings file to true to have autostart automatically.
    </issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…rver README

- Add instructions for starting the browser tunnel via Command Palette
- Document terminal.integrated.shellIntegration.enabled requirement
- Document autoStart setting for automatic tunnel startup

Co-authored-by: TheLarkInn <3408176+TheLarkInn@users.noreply.github.com>
Copilot AI changed the title [WIP] Add instructions for starting Playwright browser server docs(playwright-local-browser-server): Add getting started instructions to README Feb 3, 2026
Copilot AI requested a review from TheLarkInn February 3, 2026 15:30
@TheLarkInn TheLarkInn marked this pull request as ready for review February 3, 2026 16:00
@TheLarkInn TheLarkInn enabled auto-merge (squash) February 3, 2026 16:01
@TheLarkInn TheLarkInn merged commit 62ce9a0 into main Feb 4, 2026
9 checks passed
@TheLarkInn TheLarkInn deleted the copilot/update-readme-browser-tunnel-instructions branch February 4, 2026 00:21
@github-project-automation github-project-automation Bot moved this from Needs triage to Closed in Bug Triage Feb 4, 2026
@octogonz octogonz changed the title docs(playwright-local-browser-server): Add getting started instructions to README [playwright-local-browser-server] Add getting started instructions to README Feb 6, 2026
@octogonz octogonz changed the title [playwright-local-browser-server] Add getting started instructions to README [playwright vscode extension] Add getting started instructions to README Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Closed

Development

Successfully merging this pull request may close these issues.

[playwright-local-browser-server] Provide instructions for starting browser server

3 participants