firefox-devtools / firefox-devtools/vscode-firefox-debug

Documentation: Elaborate on url and webRoot properties

Open
#348 1 comment 0 reactions 0 assignees View on GitHub
task
Dominant language
TypeScript
Stars
447
Forks
76
PR merge metrics
No merged PRs in 30d

Description

This is a request for clarifying documentation. I don't understand what problem `url` and/or `webRoot` solve:

> You may want (or need) to debug your application running on a Webserver (especially if it interacts with server-side components like Webservices).

I know when my app needs a running webserver, but I don't understand how these properties relate. I _hoped_ they fired up a web server and served my local frontend files through it. That use case comes up for me all the time, and it's time consuming to have to figure out which web server is the easiest to set up just so I can troubleshoot some HTML/JS's behavior when it's opened locally vs through a server.

I can't tell if that's what this feature does or not. To me, that quote could be interpreted either way. Can the readme include more details about what these properties do and when you need them?

Contributor guide

Open the contributing guide

Research direction

Read the README section describing the url and webRoot properties, then verify from the existing documentation what each property affects and whether it starts a web server. Update the README to explain their purpose, when they are needed, and whether serving local frontend files is supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, vscode
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.