dotnet / dotnet/dotnet-api-docs

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

Open
#4,833 0 comments 0 reactions 0 assignees View on GitHub
area-WPF doc-enhancement Pri3 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.