Add package readmes (continued) #92228
Conversation
|
Tagging subscribers to this area: @dotnet/area-meta Issue DetailsContinuation of #91210 One of the top customer problems that package consumers are facing is lack of documentation. As such, we are driving an effort to increase the adoption and quality of NuGet package READMEs. AskTo lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs. WhyThe README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages. HowThis PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see PackagesThis list is sorted alphabetically.
✅ ( 🕜 ( cc @lyndaidaii @ericstj @jeffhandley @artl93 @MSDN-WhiteKnight
|
ViktorHofer
force-pushed
the
PackageReadmesContinued
branch
from
f846203 to
f4d8115
Compare
|
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this |
ViktorHofer
added
the
help wanted
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main... |
List related packages with adding short description and direct URI to nuget.org package. Fix dotnet#92228
List API Documentation link in Additional Documentation section. Fix dotnet#92228
Liste main types provided by library in Main Types section. Does not include internal types which are not exposed out. Fix dotnet#92228
List key features of the library. Add a short package description. Fix dotnet#92228
Typo in word 'Defult' fixed to 'Default'. Fix dotnet#92228
Typo in word 'Defult' fixed to 'Default'. Fix #92228
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet package readme See dotnet#92228
* Remove conceptual docummentation item Removed since is not applicable * List types library provides Add list of types which library provides. Listed public types, means exposed types. * Add description and usage examples Add library description. Add few code examples showing basic functionality for CBOR wirter and reader types. * Add related packages section Since different targets have different dependencies so I have divided for each section. * Improve short description Add 'format' word after abbreviation to have an object in sentence. * Remove related packages section Since there are no related packages. * Improve array reading/writing example
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet package readme See #92228 * Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md * Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md --------- Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>
|
I learn a lot on APIs I never had a reason to use. 😝 |
* Provide M.Win32.SystemEvents package readme * Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md * Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md --------- Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>
* Provide Threading.RateLimiting package readme
ghost
closed this
|
Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it. |
|
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes. And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉 |
There was a problem hiding this comment.
LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
Typo in word 'Defult' fixed to 'Default'. Fix dotnet#92228
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet package readme See dotnet#92228 * Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md * Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md --------- Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>
Continuation of #91210
One of the top customer problems that package consumers are facing is lack of documentation. As such, we are driving an effort to increase the adoption and quality of NuGet package READMEs.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see
System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.Packages
This list is sorted alphabetically.
✅ (
:white_check_mark:) -> reviewed & approved🕜 (
:clock130:) -> under reviewcc @lyndaidaii @ericstj @jeffhandley @artl93 @MSDN-WhiteKnight