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

Unable to add documentation without a sample control #57

Open
20 tasks
Arlodotexe opened this issue May 31, 2023 · 2 comments
Open
20 tasks

Unable to add documentation without a sample control #57

Arlodotexe opened this issue May 31, 2023 · 2 comments
Labels
bug 🐛 Something isn't working dev loop ➰ For issues that impact the core dev-loop of building experiments documentation 📃 Improvements or additions to documentation

Comments

@Arlodotexe
Copy link
Member

Describe the bug

Some toolkit components do not have sample controls, but do have documentation that needs to be available to end users. For example, CommunityToolkit/Labs-Windows#438.

Steps to reproduce

n/a

Expected behavior

Devs should be able to write markdown docs without an interactive sample.

Screenshots

No response

Code Platform

  • UWP
  • WinAppSDK / WinUI 3
  • Web Assembly (WASM)
  • Android
  • iOS
  • MacOS
  • Linux / GTK

Windows Build Number

  • Windows 10 1809 (Build 17763)
  • Windows 10 1903 (Build 18362)
  • Windows 10 1909 (Build 18363)
  • Windows 10 2004 (Build 19041)
  • Windows 10 20H2 (Build 19042)
  • Windows 10 21H1 (Build 19043)
  • Windows 11 21H2 (Build 22000)
  • Other (specify)

Other Windows Build number

No response

App minimum and target SDK version

  • Windows 10, version 1809 (Build 17763)
  • Windows 10, version 1903 (Build 18362)
  • Windows 10, version 1909 (Build 18363)
  • Windows 10, version 2004 (Build 19041)
  • Other (specify)

Other SDK version

No response

Visual Studio Version

No response

Visual Studio Build Number

No response

Device form factor

No response

Additional context

No response

Help us help you

Yes, I'd like to be assigned to work on this item.

@Arlodotexe Arlodotexe added bug 🐛 Something isn't working documentation 📃 Improvements or additions to documentation dev loop ➰ For issues that impact the core dev-loop of building experiments labels May 31, 2023
@michael-hawker
Copy link
Member

Believe this is just how we've implemented the source generator currently is that it expects them to be coupled to have docs which contain sample pages/live examples?

@Arlodotexe
Copy link
Member Author

Arlodotexe commented Jun 13, 2023

I can't think of any issues that should appear if we removed this limitation. As I recall, this one diagnostic was more formal than functional.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 Something isn't working dev loop ➰ For issues that impact the core dev-loop of building experiments documentation 📃 Improvements or additions to documentation
Projects
Status: 🔖 Ready
Development

No branches or pull requests

2 participants