dotnet / dotnet/dotnet-api-docs

Suggestion to add visual image at beginning of articles to show example

Aperta
#4,833 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area-WPF doc-enhancement Pri3 untriaged
Lingua principale
C#
Stelle
950
Fork
1.7k
Merge medio
2g 19h
PR unite (30g)
52

Descrizione

Following is feedback from MVP on Docs and example specific to .NET API reference content:

When it comes to Docs, I have one suggestion here: could you add some visual effect figures at the beginning of the article, such as animated GIF (best choice) to show the final effect.
Take this for example: [https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.primitives.togglebutton?view=netcore-3.1](https://docs.microsoft.com/en-us/dotnet/api/system.windows.controls.primitives.togglebutton?view=netcore-3.1)
If a person who doesn't know ToggleButton Class at all, he is more concerned with what ToggleButton really looks like, whether it can meet his requirements, rather than the definition of ToggleButton Class.
Same problems lie in the wpf control docs. Could you please consider providing a visual effect figure in these articles? I remember docs on Xamarin contain such kind of effect figures, though it is not enough.
I think readers may understand better if visual effect figures are inserted in some docs.
I've tracked to GitHub demo linked of these docs, but failed to find this kind of visual effect figures, so I had to clone the repository to see the effect in operation, which is a troublesome experience. Therefore, I sincerely make a suggestion about it. Thank you.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia esaminando il riferimento API di ToggleButton collegato e la documentazione dei controlli WPF del repository, quindi ispeziona le demo GitHub collegate menzionate nell’issue. La richiesta non specifica file, test o un insieme definito di articoli, pertanto l’ambito e i criteri di completamento dovrebbero essere stabiliti prima dell’implementazione.

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

Valutazione

Stack tecnologico
csharp
Ambito
documentation
Tipo di issue
Documentazione
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.