microsoft / microsoft/WinAppVSCE
[Docs]: Decide whether to document programmatic winapp.tool invocation
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 13
- Forks
- 3
- Avg merge
- 6d 1h
- Merged PRs (30d)
- 11
Description
What part of the documentation needs improvement?
The main README documents interactive WinApp: Run SDK Tool argument quoting, while the live-drive harness documentation describes invoking winapp.tool programmatically with { toolName, argumentText }.
Describe the change you'd like
Decide whether programmatic command invocation is a supported extension API. If supported, document its options and compatibility expectations in contributor/developer documentation. If it remains test-only, explicitly mark it internal in the harness guidance rather than adding it to end-user documentation.
Additional context
Raised during review of the shell-free winapp.tool execution change. It is intentionally out of scope for that fix because the README is user-facing and the programmatic options currently exist to make the live VS Code harness deterministic.
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.
Research direction
Review the main README and the live-drive harness documentation, focusing on the programmatic winapp.tool call with toolName and argumentText. First establish whether that interface is supported beyond the test harness; done means documenting its options and compatibility expectations, or clearly marking it internal in the harness guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100