microsoft / microsoft/vscode-azurestaticwebapps
Improve Specificity in Instructions & Documentation. "App location" is ambiguous
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 99
- Forks
- 39
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 2
Description
From the UI:
Enter the location of your application code. For example, '/' represents the root of your app...
What does this mean? What is "root of your app"? Do you mean "root of your source code repository"? Or the root of the directory I currently have open (which might not be the repo root)? Or the path to the app at run-time? On the server file system or in the URL?
From the docs:
The app location is where the project app code lives. For example, if the
srcfolder exists in theappfolder, then the valueappshould be entered.
The docs add more confusion than explanation.
if the
srcfolder exists in theappfolder, then the valueappshould be entered
What? Why would it not be /app/src ? Is /src going to be implicitly added to whatever path I enter?
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Review the UI instruction and the wiki's “app location” section linked in the issue first. Clarify what the path is relative to and how the app and src example should be interpreted; done means the UI and documentation give the same unambiguous guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, typescript, vscode
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100