Documentation: Elaborate on url and webRoot properties
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript, vscode
- Domain
- documentation
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.
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?
- Dominant language
- TypeScript
- Stars
- 447
- Forks
- 76
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from firefox-devtools/vscode-firefox-debug
-
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
firefox-devtools/vscode-firefox-debug#391 · 2 comments · 1 reaction ·
-
bug path mapping
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Castle Open
Difficulty 5/5 Over a week Newbie friendliness 10/100
-
Create new issue Open
Difficulty 5/5 Over a week Newbie friendliness 1/100
All issues in firefox-devtools/vscode-firefox-debug
Similar issues
-
blocklist removal
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
MetaMask/eth-phishing-detect#296544 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
pastelsky/bundlephobia#1122 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
category/development priority/P2 scope/file-operations scope/testing type/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Enatega Customer and Rider app: Add-ons price is not visible to customer after order is placed. Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100