CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

Show compatible targets within docs and gallery

Abierto
#144 1 comentario 0 reacciones 0 asignados Ver en GitHub
documentation :page_with_curl: sample app 🖼
Lenguaje dominante
C#
Estrellas
56
Forks
19
Merge medio
40 min
PR fusionados (30 d)
1

Descripción

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

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza leyendo DocumentationRenderer, MultiTarget.props y GenerateMultiTargetAwareProjectReferenceProps.ps1; después, inspecciona el script externo de exportación de documentación descrito en el issue. El trabajo estará terminado cuando los valores de MultiTarget o TargetFramework compatibles aparezcan tanto en los encabezados de la galería de ejemplos como en la documentación publicada, sin mostrarse en línea.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
powershell, wasm
Área
build-system, documentation
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.