Skip to content
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

Multiple samples for the same Lab/Experiment #21

Closed
Arlodotexe opened this issue Dec 30, 2021 · 4 comments · Fixed by #85
Closed

Multiple samples for the same Lab/Experiment #21

Arlodotexe opened this issue Dec 30, 2021 · 4 comments · Fixed by #85
Assignees
Labels
build 🔥 documentation 📃 Improvements or additions to documentation sample app 🖼

Comments

@Arlodotexe
Copy link
Member

Arlodotexe commented Dec 30, 2021

Overview:

As mentioned here, we may want to take inspiration from the XAML Control Gallery and allow for multiple, separate samples under the same Lab/Experiment.

This would help clean up samples that already contain multiple other samples, like SwitchPresenter, OrbitView, and TextBoxMask, by physically separating them into separate samples with their own copy-able code and settings to tweak.

It would also allow us to embed each one inline with documentation, or deep-link to a very specific sample.

Current toolkit:

image
image

XAML Control Gallery (proposed approach)

image

image

@Arlodotexe Arlodotexe self-assigned this Dec 30, 2021
@Arlodotexe
Copy link
Member Author

@michael-hawker @Sergio0694 Would appreciate your feedback on this :)

@michael-hawker
Copy link
Member

michael-hawker commented Jan 11, 2022

Yeah, this sounds exactly what I was thinking we'd end up with. Though I think we'd have two different versions.

In the single-experiment mode where a developer is developing, each sample would be its own page listed out on the navigation bar, as it'd be only displaying this experiment. (And one tab would also be the doc page.)

In the multi-experiment mode, it would use the doc page as the main page template, and then the documentation would have a tag call out like [[Sample1]] (in whatever syntax we decide) then it would insert that example in that spot. (This is kind of what we tried to do in the MVVM Samples app https://github.com/CommunityToolkit/MVVM-Samples)

Arlo suggested that we could have a button to toggle the navigation type between the basic mode we use per-experiment and the hybrid documentation mode...

We can use the right-side bar that the control gallery has to jump to the specific sections/samples in the doc as well.

@michael-hawker
Copy link
Member

michael-hawker commented Apr 5, 2022

@Arlodotexe I'm going to try and tackle this with #5 as well; so will assign to me for now?

@michael-hawker
Copy link
Member

Fixed by #85

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build 🔥 documentation 📃 Improvements or additions to documentation sample app 🖼
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants