Tooling-Windows-Submodule icon indicating copy to clipboard operation
Tooling-Windows-Submodule copied to clipboard

Show compatible targets within docs and gallery

Open Arlodotexe opened this issue 9 months ago • 0 comments

          > 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.

The script linked is for modifying the documents before exporting for publishing on learn.microsoft.com. It replaces our custom ![SAMPLE_NAME] syntax with the content of the sample and updates all learn.microsoft.com links to be relative.

We 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:

  1. The DocumentationRenderer needs to identify what MultiTargets are supported for the component a given document is contained in, and display it in the header.
  2. The doc export script (the one linked, not yet in the repo) provided will need to pull from MultiTarget.props and inject it as front-matter, which can be consumed and rendered by docfx. We can extract/reuse existing code in GenerateMultiTargetAwareProjectReferenceProps.ps1 for this, but it's not yet clear how we'd display this on the learn.microsoft.com side of things.

Once we have these, we can display the supported MultiTarget or TargetFrameworks for a component within both the sample gallery and the published documentation.

Originally posted by @Arlodotexe in https://github.com/CommunityToolkit/Tooling-Windows-Submodule/issues/141#issuecomment-1734428223

Arlodotexe avatar Sep 25 '23 23:09 Arlodotexe