CommunityToolkit / CommunityToolkit/Tooling-Windows-Submodule

Sample Display Options

Offen
#81 0 Kommentare 2 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
documentation :page_with_curl: enhancement help wanted sample app 🖼
Vorherrschende Sprache
C#
Sterne
55
Forks
19
Ø Merge
40 Min.
Gemergte PRs (30 T.)
1

Beschreibung

In the doc tag for samples:

```
> [!SAMPLE ContentSizerTopShelfPage]
```

We should have a way to specify if we only want C# or XAML displayed

```
> [!SAMPLE ContentSizerTopShelfPage Show="XAML"]
```

Where `Show` can be `XAML`, `C#`, or `All` for instance.

Would provide us some flexibility in scoping to what's interesting or being able to write UI to showcase more C# API focused examples without showing all the UI that's not the interesting bit.

This'll also help us when we go to dump the info to format things properly for static doc generation.

We also have an issue around how large each sample area takes within the docs (or when in the TabbedPage), though we may want a simple issue for that? I don't think we want that to be configured but either fixed or dynamic within the app?

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die Verarbeitung von Doc-Tags für `[!SAMPLE ...]` und den Rendering-Pfad zu finden, der für Beispiele in der Dokumentation und bei der Generierung statischer Dokumentation verwendet wird. Ermittle, an welcher Stelle ein `Show`-Wert XAML, C# oder den gesamten Inhalt auswählen könnte; abgeschlossen ist die Aufgabe, wenn die Beispiele die angeforderte Option unterstützen, ohne das Standardverhalten zu ändern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp
Bereich
documentation, tooling
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.