Update Labs Readme #147
Update Labs Readme #147
Conversation
…s, repo structure, and advanced config scripts.
michael-hawker
added
the
documentation 📃
|
|
||
| If you skipped the [Wiki page on Toolkit Labs](https://aka.ms/toolkit/wiki/labs), then you can go to the [wiki page on Preview Packages](https://aka.ms/toolkit/wiki/previewpackages) and find out how to add our NuGet Feed to Visual Studio: | ||
| > <https://pkgs.dev.azure.com/dotnet/CommunityToolkit/_packaging/CommunityToolkit-Labs/nuget/v3/index.json> |
There was a problem hiding this comment.
Why's this here?
Should it go in the above-linked wiki?
There was a problem hiding this comment.
Yes, it's there as well, just pulling it out directly to be more visible and a break that would let folks stop while reading and see there's a specific feed.
|
|
||
| If you find an experiment useful, please up-vote 👍 its corresponding issue. Each experiment has an issue assigned to it with the `experiment` label for tracking. Please file any feedback or issues about that experiment on that singular issue. For any other questions or concerns, please open a Discussion. | ||
| Otherwise, you can clone the repo, open the `labs` directory, navigate within the folder for a particular experiment and open up it's solution file in Visual Studio. Run one of the project heads (_ExperimentName.Uwp/Wasm/WinAppSDK_) to see its samples. |
There was a problem hiding this comment.
Should this also mention using code spaces?
There was a problem hiding this comment.
Yeah, I think it's something to call out and explain better. Maybe in the wiki once we have that setup. That's only going to be available to folks that are part of the Toolkit org, so I don't think it's something we need to call out just yet. I'm sure there's more we'll add here in the future. Goal here was just to add a bit more detail to the current setup.
|
|
||
| ## Adding a new Experiment | ||
|
|
||
| To start a new experiment, open up a new Discussion to propose your idea with the community. Be sure to follow the template and highlight reasons why and how your idea can aid other developers. | ||
|
|
||
| Once there is traction an issue will be created to track your experiment and its progress. | ||
| Once there is traction and your idea is approved, an issue will be created to track your experiment and its progress. |
There was a problem hiding this comment.
This sentence raises lots of questions:
How is traction defined?
How do ideas get approved?
What if an idea isn't approved?
How is progress tracked?
etc.
I'm not saying answers to these questions need to be in this document, but they need to be somewhere to set appropriate expectations.
There was a problem hiding this comment.
Yes, we've still got #47 open which is to track more of these details, which we'll put in the wiki. Definitely something we should have documented.
|
I'll merge this in for now, @niels9001 want to try out the readme instructions to try building the sample app? Let us know how that goes and feel free to add any comments or suggestions here. |
Includes some more information about requirements, repo structure, and advanced config scripts.
FYI @azchohfi let me know if this would have been helpful originally as you tried to bootstrap.
There'll still be some more links/details to add later, but this is at least more current with what we have going now.