[DOC] Improving `Messenger` documentation with better code based context.

Open
#481 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Open docs/mvvm/Messenger.md and compare it with the linked Messenger page. Identify examples that rely mainly on text-based context and revise them to show how the pieces fit together in code. The documentation is done when the page provides clearer code-based examples for Messenger usage.

Written by the indexing model from the issue text.

Description

Pri3
Type of issue

Other (describe below)

Description

I believe that the documentation for Messenger in the MVVM Toolkit is difficult to understand. Specifically, the examples contain a lot of text-based context instead of code-based context. It would be very helpful to see more examples showing how things fit together in code.

Page URL

https://learn.microsoft.com/en-us/dotnet/communitytoolkit/mvvm/messenger

Content source URL

https://github.com/MicrosoftDocs/CommunityToolkit/blob/main/docs/mvvm/Messenger.md

Document Version Independent Id

https://github.com/MicrosoftDocs/CommunityToolkit/blob/e96e43db0cdbe3a355ee75cfd02f709bf1c8fcfa/docs/mvvm/Messenger.md

Article author

CommunityToolkit

Metadata

No response

Dominant language
No language data
Stars
168
Forks
134
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MicrosoftDocs/CommunityToolkit

All issues in MicrosoftDocs/CommunityToolkit

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.