New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Quick start doc in README #1059
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is very good information.
I don't want to prescribe too much in terms of style or tone, but could if you like.
Some things it might be worth mentioning:
- Why Stdio doesn't support the Integrated Console
- What startup looks like and what the timing is between client and server (so people don't think the script has hung)
- Security considerations for clients using named pipes
- How shutdown works and the lifetime of the server compared to the client
- What we consider to be stable and what clients can depend on (messages vs linking)
- Why debugging with PowerShell is a bit different (i.e. happens in the same process)
I agree with what you're saying but I think a lot of what you're suggesting should be in a more exhaustive doc instead of a quick start that this is trying to be. |
Added
Added
Should be in a different doc
Should be in a different doc
Added
Added |
Co-Authored-By: Robert Holt <rjmholt@gmail.com>
fixes #1057
Note, this is not exhaustive but I wanted to write something down to at least give folks a place to start.
In theory a more exhaustive doc should be elsewhere (like on docs.microsoft.com) but this will do for now.