-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Enable a sample-first development experience for new packages #11378
Comments
@willmtemple Do we see an overlap between this issue and #7651 and |
@ramya-rao-a Yes. One very simple way that we could enable a better experience than we have now is if we can set up a post-install hook using Rush to link the samples to the development package. This is what I do locally on my development machine with With a more fully-featured samples management process, we can make it work out of the box by keeping the samples in the tsconfig project tree. If we do that, then we can also debug them using the same settings as for tests and package code. This is effectively what C# does, but they don't publish their samples as source code projects like we do, and they don't have to support two languages like we do. We will have to do a little more work to move things around and keep them in the right shape. |
I feel like the current sample authoring experience is pretty good now. @willmtemple is there anything we still need to do here? |
@xirzec closing, as new packages should be able to easily start with samples. |
Today authoring samples is very difficult (no good IntelliSense) and is oriented towards providing content that will work on docs.microsoft.com.
However, it is very useful for a library author to be able to interactively build up a sample program while they are testing out and designing their new client. As such, I'd like to accomplish the following:
This will put us on-par with other languages (e.g. C#) in allowing library authors to get a sense of the developer experience they will be providing to customers, even before their library is fully functional/implemented.
The text was updated successfully, but these errors were encountered: