-
Notifications
You must be signed in to change notification settings - Fork 11
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
Implemented new AddMultiTargetCompatibleSampleDocs target #141
Conversation
I realized I haven't opened a PR for the doc export script: https://github.com/CommunityToolkit/Tooling-Windows-Submodule/blob/llama/export-docs/Scripts/ExportDocs.ps1 One thing we'll have to think about is how we mark which platforms are supported within the docs and that script. Like for now for WASM it's easiest to remove the markdown files, but we may want to modify this approach to inject the supported platforms into the doc and possible just turn-off sample compilation for unsupported platforms or something. What that be something we can add in the future with this approach or require other tooling? |
The script you've linked is for modifying the documents before exporting for publishing on learn.microsoft.com. It replaces our custom It sounds like you want to display which MultiTarget or TargetFramework a component is supported on from the learn.microsoft.com side of things for our users. Would this be as inline text, as metadata, or something else? This would be in addition to the information available on the "Frameworks" tab shown on nuget.org. We'll need to also display this information in the header for the sample gallery. For display purposes, we should avoid doing this inline. That means we'll need the following:
Once we have these, we can display the supported MultiTarget or TargetFrameworks for a component within both the sample gallery and the published documentation. |
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.
Seems to work well. Later we'll want to adjust the template/solution generation steps to not include the single-WASM head in the components that won't support it. Same for things like UWP in the future if we have something that is only built against WASDK.
This PR:
CheckMultiTarget
to verify multi-target compatibility for the files provided to it.AddMultiTargetCompatibleSampleDocs
which filters markdown files based on platform compatibility.obj
andbin
directories to prevent processing unnecessary files.