CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

Show compatible targets within docs and gallery

Aperta
#144 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
documentation :page_with_curl: sample app 🖼
Lingua principale
C#
Stelle
55
Fork
19
Merge medio
40m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia leggendo DocumentationRenderer, MultiTarget.props e GenerateMultiTargetAwareProjectReferenceProps.ps1, quindi esamina lo script esterno di esportazione della documentazione descritto nell’issue. Il lavoro è completo quando i valori MultiTarget o TargetFramework supportati compaiono sia nelle intestazioni della galleria di esempi sia nella documentazione pubblicata, senza visualizzazione inline.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
powershell, wasm
Ambito
build-system, documentation
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.